feat(changelog): add github markdown support

zbindenren · Jan 4, 2021 · a1f6009 · a1f6009
1 parent 30cc4d8
commit a1f6009
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 33 deletions.
diff --git a/config/config.go b/config/config.go
@@ -26,8 +26,8 @@ var (
 
 // Changelog configures the changelog.
 type Changelog struct {
-	Sections []Section `yaml:"sections"`
-	Flavor   string    `yaml:"flavor"`
+	Sections          []Section `yaml:"sections"`
+	GithubProjectPath string    `yaml:"github_project_path"`
 }
 
 // Section is a section config.
@@ -84,10 +84,6 @@ func (c Changelog) Validate() error {
 		}
 	}
 
-	if !(c.Flavor == "gitlab" || c.Flavor == "github") {
-		return errors.New("flavor has to be either 'gitlab' or github")
-	}
-
 	return nil
 }
 
@@ -123,9 +119,7 @@ func Read(r io.Reader) (*Changelog, error) {
 		return nil, err
 	}
 
-	c := Changelog{
-		Flavor: "gitlab",
-	}
+	c := Changelog{}
 
 	if err := yaml.Unmarshal(b, &c); err != nil {
 		return nil, fmt.Errorf("failed to unmarshal yaml: %w", err)
@@ -152,7 +146,6 @@ func Write(dir string, c Changelog) error {
 
 // Default represents the default configuration.
 var Default = Changelog{
-	Flavor: "gitlab",
 	Sections: []Section{
 		{
 			Type:   "build",

diff --git a/internal/changelog/changelog.go b/internal/changelog/changelog.go
@@ -27,11 +27,10 @@ const (
 
 // Changelog creates a changelog.
 type Changelog struct {
-	githubProjectPath string
-	typeSections      typeSections
-	cfg               config.Changelog
-	releaseType       ReleaseType
-	logFunc           func(msg string, keysAndValues ...interface{})
+	typeSections typeSections
+	cfg          config.Changelog
+	releaseType  ReleaseType
+	logFunc      func(msg string, keysAndValues ...interface{})
 }
 
 // New creates a new Changelog.

diff --git a/internal/changelog/markdown.go b/internal/changelog/markdown.go
@@ -114,7 +114,7 @@ func (c *Commit) writeStandard(w io.Writer) {
 
 func (c Changelog) issueURL(issueNumber int) string {
 	// gitlab renders link automatically for revisions
-	if c.githubProjectPath == "" {
+	if c.cfg.GithubProjectPath == "" {
 		return fmt.Sprintf("#%d", issueNumber)
 	}
 
@@ -123,7 +123,7 @@ func (c Changelog) issueURL(issueNumber int) string {
 		issuesPath = githubIssuesPath
 	)
 
-	url := path.Join(githubURL, c.githubProjectPath, issuesPath) + "/"
+	url := path.Join(githubURL, c.cfg.GithubProjectPath, issuesPath) + "/"
 	issue := fmt.Sprintf("#%d", issueNumber)
 
 	s.WriteRune('[')
@@ -138,7 +138,7 @@ func (c Changelog) issueURL(issueNumber int) string {
 }
 func (c Changelog) revisionURL(revision string) string {
 	// gitlab renders link automatically for revisions
-	if c.githubProjectPath == "" {
+	if c.cfg.GithubProjectPath == "" {
 		return revision
 	}
 
@@ -147,7 +147,7 @@ func (c Changelog) revisionURL(revision string) string {
 		commitPath = githubCommitPath
 	)
 
-	url := path.Join(githubURL, c.githubProjectPath, commitPath) + "/"
+	url := path.Join(githubURL, c.cfg.GithubProjectPath, commitPath) + "/"
 
 	s.WriteRune('[')
 	s.WriteString(revision[:8])

diff --git a/internal/changelog/option.go b/internal/changelog/option.go
@@ -12,20 +12,6 @@ type Option func(*Changelog) error
 // LogFunc is a logging function.
 type LogFunc func(msg string, keysAndValues ...interface{})
 
-// WithGithubProjectPath configures the project path for github. This determines how links to issues and
-// commits are created.
-func WithGithubProjectPath(projectPath string) Option {
-	return func(c *Changelog) error {
-		if projectPath == "" {
-			return errors.New("project path is empty")
-		}
-
-		c.githubProjectPath = projectPath
-
-		return nil
-	}
-}
-
 // WithConfig configures how header types are mapped to headings and which
 // sections are hidden.
 func WithConfig(cfg config.Changelog) Option {