diff --git a/.goreleaser.yml b/.goreleaser.yml index 3acf6ecb..001a2473 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -22,9 +22,12 @@ builds: mod_timestamp: '{{ .CommitTimestamp }}' ldflags: - >- - -X github.com/oliverbaehler/{{ .ProjectName }}/cmd/{{ .ProjectName }}/cmd.Version={{ .Tag }} - -X github.com/oliverbaehler/{{ .ProjectName }}/cmd/{{ .ProjectName }}/cmd.GitCommit={{ .Commit }} - -X github.com/oliverbaehler/{{ .ProjectName }}/cmd/{{ .ProjectName }}/cmd.BuildDate={{ .Date }} + -X main.Version={{ .Tag }} + -X main.GitCommit={{ .Commit }} + -X main.GitTag={{ .Tag }} + -X main.GitTreeState={{ .Date }} + -X main.BuildDate={{ .Date }} + -X main.GitRepo={{ .ProjectName }} release: prerelease: auto footer: | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42a6342e..03bf8c90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,21 +9,30 @@ All contributions are welcome! If you find a bug or have a feature request, plea ## Pull Requests -### Commits +## Commits Commit messages should indicate the change and it's impact. The general format for commit messages is the following: - (): cool contribution + feat(ui): Add `Button` component + ^ ^ ^ + | | |__ Subject + | |_______ Scope + |____________ Type -The following `` items are available: + The commits are checked on pull-request. If the commit message does not follow the format, the workflow will fail. See the [Types](#types) and [Scopes](#scopes) sections for more information. + +## Types + +The following types are allowed for commits and pull requests: * `ci` or `build`: changes to buillding process/workflows * `docs`: changes to documentation * `feat`: new features * `fix`: bug fixes - * `fix(deps)` or `feat(deps)`: dependency updates -The changes should be grouped by component. The following `` items are available: +## Scopes + +The following types are allowed for commits and pull requests: * `all`: changes that affect all components * `chart`: changes to the Helm chart @@ -36,8 +45,6 @@ The changes should be grouped by component. The following `` items ar * `release`: changes to the release process * `deps`: dependency updates -The commits are checked on pull-request. If the commit message does not follow the format, the workflow will fail. - ### Sign-Off Developer Certificate of Origin (DCO) Sign off