Release 0.0.1

[bgilbert]

Release process

This project uses cargo-release in order to prepare new releases, tag and sign the relevant git commit, and publish the resulting artifacts to crates.io. The release process follows the usual PR-and-review flow, allowing an external reviewer to have a final check before publishing.

Requirements

This guide requires:

• A web browser (and network connectivity)
• git
• GPG setup and personal key for signing
• cargo (suggested: latest stable toolchain from rustup)
• cargo-release (suggested: cargo install -f cargo-release)
• A verified account on crates.io
• Write access to this GitHub project
• Membership in the Fedora CoreOS Crates Owners group, which will give you upload access to crates.io

Release checklist

These steps show how to release version x.y.z on the origin remote (this can be checked via git remote -av). Push access to the upstream repository is required in order to publish the new tag and the PR branch.

:warning:: if origin is not the name of the locally configured remote that points to the upstream git repository (i.e. git@github.com:coreos/ignition-config-rs.git), be sure to assign the correct remote name to the UPSTREAM_REMOTE variable.

• make sure the project is clean and prepare the environment:

  • [x] cargo test
  • [x] cargo clean
  • [x] git clean -fd
  • [x] RELEASE_VER=x.y.z
  • [x] UPSTREAM_REMOTE=origin

• create release commits on a dedicated branch and tag it (the commits and tag will be signed with the GPG signing key you configured):

  • [x] git checkout -b release-${RELEASE_VER}
  • [x] cargo release (and confirm the version when prompted)

• open and merge a PR for this release:

  • [x] git push ${UPSTREAM_REMOTE} release-${RELEASE_VER}
  • [x] open a web browser and create a PR for the branch above
  • [x] make sure the resulting PR contains exactly two commits
  • [x] in the PR body, write a short changelog with relevant changes since last release
  • [x] get the PR reviewed, approved and merged

• publish the artifacts (tag and crate):

  • [x] git checkout v${RELEASE_VER}
  • [x] verify that grep "^version = \"${RELEASE_VER}\"$" Cargo.toml produces output
  • [x] git push ${UPSTREAM_REMOTE} v${RELEASE_VER}
  • [x] cargo publish

• publish this release on GitHub:

  • [x] find the new tag in the GitHub tag list, click the triple dots menu, and create a release for it
  • [x] write a short changelog (i.e. re-use the PR content)
  • [x] record digest of crate:
  • sha256sum target/package/ignition-config-rs-${RELEASE_VER}.crate
  • [x] publish release

• clean up:

  • [x] cargo clean
  • [x] git checkout main
  • [x] git pull ${UPSTREAM_REMOTE} main
  • [x] git push ${UPSTREAM_REMOTE} :release-${RELEASE_VER}
  • [x] git branch -d release-${RELEASE_VER}