Skip to content

Commit

Permalink
feat(config): Add config file path: .github/changelog-generator.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe565 committed May 4, 2024
1 parent ef20120 commit d34c9f5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ jobs:
```
## Configuration
Changelog Generator can be configured by committing a file to one of the paths listed below. See the [config example](config_example.yaml) for available configuration documentation.
Configuration is loaded from `.changelog-generator.yaml` in the git repo root. See the [config example](config_example.yaml) for more details.

If `.changelog-generator.yaml` is not found, Changelog Generator will attempt to load the `changelog` key from `.goreleaser.yaml`.
#### Default Paths
- `.changelog-generator.yaml`
- `.github/changelog-generator.yaml`
- `.goreleaser.yaml`.
2 changes: 2 additions & 0 deletions internal/config/load.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ func Load(cmd *cobra.Command) (*Config, error) {
cfgFiles = append(cfgFiles,
filepath.Join(repoPath, ".changelog-generator.yaml"),
filepath.Join(repoPath, ".changelog-generator.yml"),
filepath.Join(repoPath, ".github", "changelog-generator.yaml"),
filepath.Join(repoPath, ".github", "changelog-generator.yml"),
filepath.Join(repoPath, ".goreleaser.yaml"),
filepath.Join(repoPath, ".goreleaser.yml"),
)
Expand Down

0 comments on commit d34c9f5

Please sign in to comment.