Skip to content

Latest commit

 

History

History
101 lines (86 loc) · 3.85 KB

RELEASE.md

File metadata and controls

101 lines (86 loc) · 3.85 KB
Raw

Release

The release process for the wdl family of crates is intentionally disjoint across the repository. When releasing any new packages:

  • You should first release each of the component crates (all crates that are not wdl) in a sequential fashion using the component crates section.
  • Next (if desired), you should release the convenience crate (the wdl crate) by following the convenience crate section.

Notably, updates to the files listed below should be grouped in a single commit per crate, but updates to these files across crates should not be contained within a single commit.

Component Crates

Note: in this example, we will be using the wdl-grammar crate. Please substitute the name of the crate that you are working on.

Note: crates should be released sequentially based on the dependency tree. For example, wdl-grammar should be released before wdl-ast, as wdl-ast depends on wdl-grammar.

For every component crate that has changes:

  • Update version in Cargo.toml.
  • Update versions of any wdl-* crate dependencies in Cargo.toml.
    • If any of the crates do not have updated versions, be sure they also don't have changes to release. If they do, you may be releasing the crates out of order!
  • Update CHANGELOG.md with version and publication date.
    • To get the changes to the crate since the last release, you can use a command like the following: 
      git log wdl-grammar-v0.1.0..HEAD --oneline -- wdl-grammar
  • Run tests: cargo test --all-features.
  • Run tests for examples: cargo test --examples --all-features.
  • Run linting: cargo clippy --all-features.
  • Run fmt: cargo fmt --check.
  • Run doc: cargo doc.
  • Stage changes: git add Cargo.toml CHANGELOG.md.
  • Create git commit: 
    git commit -m "release: bumps `wdl-grammar` version to v0.1.0"
  • Create git tag: 
    git tag wdl-grammar-v0.1.0
  • Push release: git push && git push --tags.
  • Publish the component crate: cargo publish --all-features.
  • Go to the Releases page in Github, create a Release for this tag, and copy the notes from the CHANGELOG.md file.

Convenience Crate

From the root directory:

  • Update the version of the top-level crate in the root Cargo.toml.

    • Note: changes to the version number will be automatically reflected in wdl/Cargo.toml, as the version there is specified as version.workspace = true.

  • Run tests: cargo test --all-features.

  • Run tests for examples: cargo test --examples --all-features.

  • Run linting: cargo clippy --all-features.

  • Run fmt: cargo fmt --check.

  • Run doc: cargo doc.

  • Stage changes: git add Cargo.toml.

  • Create git commit:

    git commit

    The commit message should have a body conforming to this style:

    release: bumps `wdl` version to v0.1.0

Component Crate Updates
-----------------------

* `wdl-grammar`: introduced at v0.1.0 ([release](https://github.com/stjude-rust-labs/wdl/releases/tag/wdl-grammar-v0.1.0))
* `wdl-fictitous`: bumped from v0.1.0 to v0.2.0 ([release](https://github.com/stjude-rust-labs/wdl/releases/tag/wdl-fictitous-v0.2.0))

  • Create git tag: git tag wdl-v0.1.0.

  • Push release: git push && git push --tags.

  • Publish the new crate: cargo publish --all-features -p wdl.

  • Go to the Releases page in Github, create a Release for this tag, and copy the body from the commit message that describes the package version updates.

    • Ensure that you change the heading style from 
      Component Crate Updates
-----------------------
      to 
      ## Component Crate Updates