Skip to content

Files

Latest commit

 

History

History
17 lines (16 loc) · 1.41 KB

RELEASING.md

File metadata and controls

17 lines (16 loc) · 1.41 KB

Creating a new release

  1. Use go-licenses to ensure all project dependency licenses are correctly represented in this repository:
    • Install go-licenses (if not already installed) go install github.com/google/go-licenses@latest
    • Run and save licenses go-licenses save github.com/honeycombio/honeycomb-lambda-extension --save_path="./LICENSES"
    • If there are any changes, submit PR to update licenses.
  2. Draft a docs PR for this release.
  3. Update CHANGELOG.md with the changes since the last release.
  4. Commit changes, push, and open a release preparation PR for review.
  5. Once the pull request is merged, fetch the updated main branch.
  6. Apply a tag for the new version on the merged commit (e.g. git tag -a v2.3.1 -m "v2.3.1")
  7. Push the tag upstream to kick off the release pipeline in CI (e.g. git push origin v2.3.1). This will create a draft GitHub release with build artifacts and will publish the new layer version in AWS.
  8. Craft a release.json for this release. Most of the content for a release.json appears in the output of the publish_aws CI job.
  9. Edit the draft GitHub release:
    • Click the Generate Release Notes button and double-check the content against the CHANGELOG.
    • Attach the updated release.json to the release as a "binary".
  10. Return to the docs PR and update data/projects/honeycomb-lambda-extension/release.json and get a review!