Skip to content

Latest commit

 

History

History
39 lines (33 loc) · 2.66 KB

RELEASE.md

File metadata and controls

39 lines (33 loc) · 2.66 KB
Raw

Releasing the Elastic CI Stack for AWS

A super quick rundown of the steps to release the AWS Elastic Stack:

  1. Install golang with brew install go
  2. Install ghch with go get github.com/Songmu/ghch/cmd/ghch.
  3. Generate a changelog to preview the changes ghch --format=markdown --from=v5.7.0 --next-version=v5.7.0 and decide whether this is a major, minor, or bugfix release. Re-run ghch if necessary to change the next version.
  4. Create a branch to update the changelog e.g. keithduncan/release/v5.4.0
  5. Update CHANGELOG.md, rearrange it into whatever categories makes sense, usually Added, Changed, Fixed, Removed
    1. Commit the changelog (don’t use [skip CI] in the commit message, that will prevent the tag from kicking off a build)
    2. Push the branch
  6. While waiting for the branch to build, test and deploy...
  7. Draft a release in GitHub
    1. Fill in the release version as a git tag, use the release branch as a tag target
    2. Set the release title to the the release version
    3. Add upgrade instructions to the end of the GitHub release (copied and updated from the previous one) and update the version numbers in the links.
    4. Save the release as a draft (doesn't create the tag until the release is published)
  8. Once the branch build has passed, deploy the stack and perform manual of changed aspects. Once you are satisfied the changes are good and there aren't any regressions, publish the draft GitHub release to create the tag and kick off the tag build process, which builds in the Buildkite AWS Stack pipeline.
  9. Once the tag is building, merge the release branch to the repository’s default branch
  10. Update buildkite/docs with the versions of installed software

Announcements

Draft a Buildkite Changelog using the following template:

Title: Agent vx.x.x and AWS Elastic Stack vx.x.x release Content: The x.x.x version of the buildkite-agent and the x.x.x version of the AWS elastic stack are now available.

The agent has added the ability to do ____, and ____. This agent release has been added to the x.x.x release of the elastic stack, as well as ____ and ____.

For full list of additions, changes, and fixes, see the buildkite-agent changelog and the elastic-ci-stack-for-aws changelog on GitHub.

Publish a 🚀 Release category message in the 🤖 Agent Message Board.

Notify the Buildkite Community #aws-stack Slack channel of the new release.