Skip to content

Latest commit

 

History

History
17 lines (10 loc) · 1.46 KB

RELEASE.md

File metadata and controls

17 lines (10 loc) · 1.46 KB

Release Process

Between Releases

Various CI features have been implemented to ease the release process, but some parts of it are still intended to be manual. e.g. each CHANGELOG for each individual crate should be written by hand prior to release. We subscribe to the philosphy outlined on the keepachangelog site. The short version is that (almost) every PR should include a manually written entry to one or more CHANGELOGs in the repository under the ## Unreleased header.

Time to Release!

The first step in making a release is to run the bump GitHub action. This action will do two things:

  1. Go through each publishable wdl-* crate and increment the version in Cargo.toml (as well as match any internal dependency versions that need to be bumped).
  2. Update each CHANGELOG.md file with a new release header.
    • This piece of the ci code relies on the line ## Unreleased being present in the CHANGELOG.md file (see the ci crate code for details).

Then the bump action will open a PR with the above changes for manual review. Please ensure everything looks good and the CI is passing before merging the PR!

Once the bump PR merges, tag the HEAD commit with wdl-v{VERSION} (where VERSION matches the latest version in wdl/Cargo.toml) and the CI should handle the rest!