From b7192023b7b479fbc0f3413f04c754b38ae63c69 Mon Sep 17 00:00:00 2001 From: Zeu Capua Date: Thu, 10 Oct 2024 11:37:21 -0700 Subject: [PATCH] add comment preamble to generated config --- cmd/generate/config/output.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cmd/generate/config/output.go b/cmd/generate/config/output.go index 2743b5a..0258f41 100644 --- a/cmd/generate/config/output.go +++ b/cmd/generate/config/output.go @@ -15,6 +15,9 @@ func generateOutputFile(outputPath string, attributionMap map[string][]string) e } defer file.Close() + // write the header preamble + _, err = file.WriteString("# Configuration for attributing commits with emails to GitHub user profiles\n# Used during codeowners generation.\n\n# List the emails associated with the given username\n# The commits associated with these emails will be attributed to\n# the username in this yaml map. Any number of emails may be listed\n\n") + var config config.Spec config.Attributions = attributionMap