You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Migrate from CircleCI to GitHub Actions for tests and releases (#27)
This also enables linting via `actionlint` and `golangci-lint`. The Contributing Guide is updated with information how to run tooling locally and prepare releases using the new process.
This section is dedicated to the maintainers of this project.
220
+
221
+
### Releases
222
+
223
+
Before running a release, the changelog must be constructed from unreleased entries in the `.changelog` directory.
224
+
225
+
Install the latest version of the [`changelog-build`](https://pkg.go.dev/github.com/hashicorp/go-changelog/cmd/changelog-build) command, if it not already available:
226
+
227
+
```shell
228
+
go install github.com/hashicorp/go-changelog/cmd/changelog-build
229
+
```
230
+
231
+
Run the [`changelog-build`](https://pkg.go.dev/github.com/hashicorp/go-changelog/cmd/changelog-build) command from the root directory of the repository:
This will generate a section of Markdown text for the next release. Open the `CHANGELOG.md` file, add a `# X.Y.Z` header as the first line, then add the output from the `changelog-build` command.
238
+
239
+
Commit, push, create a release Git tag, and push the tag:
240
+
241
+
```shell
242
+
git add CHANGELOG.md
243
+
git commit -m "Update CHANGELOG for v1.2.3"
244
+
git push
245
+
git tag v1.2.3
246
+
git push --tags
247
+
```
248
+
249
+
GitHub Actions will pick up the new release tag and kick off the release workflow.
0 commit comments