Release 0.1.5

[HuijingHei]

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.

In order to ease downstream packaging of Rust binaries, an archive of vendored dependencies is also provided (only relevant for offline builds).

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)
• cargo vendor-filterer (suggested: cargo install -f cargo-vendor-filterer)
• Write access to this GitHub project
• A verified account on crates.io
• 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/ssh-key-dir.git), be sure to assign the correct remote name to the UPSTREAM_REMOTE variable.

• prepare environment:

  • [x] RELEASE_VER=x.y.z
  • [x] UPSTREAM_REMOTE=origin
  • [x] git checkout -b pre-release-${RELEASE_VER}

• check Cargo.toml for unintended increases of lower version bounds:

  • [x] git diff $(git describe --abbrev=0) Cargo.toml

• update all dependencies:

  • [x] cargo update
  • [x] git add Cargo.lock && git commit -m "cargo: update dependencies"

• write release notes:

  • [x] write release notes in docs/release-notes.md
  • [x] git add docs/release-notes.md && git commit -m "docs/release-notes: update for release ${RELEASE_VER}"

• land the changes:

  • [x] PR the changes, get them reviewed, approved and merged
  • [ ] if doing a branched release, also include a PR to merge the docs/release-notes.md changes into main

• make sure the project is clean:

  • [x] Make sure cargo-release and cargo-vendor-filterer are up to date: cargo install cargo-release cargo-vendor-filterer
  • [x] git checkout main && git pull ${UPSTREAM_REMOTE} main
  • [x] cargo vendor-filterer target/vendor
  • [x] cargo test --all-features --config 'source.crates-io.replace-with="vv"' --config 'source.vv.directory="target/vendor"'
  • [x] cargo clean
  • [x] git clean -fd

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

  • [x] git checkout -b release-${RELEASE_VER}
  • [x] cargo release --execute ${RELEASE_VER} (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 one commit
  • [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

• assemble vendor archive:

  • [x] cargo vendor-filterer --format=tar.gz --prefix=vendor target/ssh-key-dir-${RELEASE_VER}-vendor.tar.gz

• 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] copy in the changelog from the release notes doc
  • [x] upload target/ssh-key-dir-${RELEASE_VER}-vendor.tar.gz
  • [x] record digests of local artifacts:
  • sha256sum target/package/ssh-key-dir-${RELEASE_VER}.crate
  • sha256sum target/ssh-key-dir-${RELEASE_VER}-vendor.tar.gz
  • [x] publish release

• clean up the local environment (optional, but recommended):

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

• Fedora packaging:

  • [x] update the rust-ssh-key-dir spec file in Fedora
  • bump the Version
  • switch the Release back to 1%{?dist}
  • remove any patches obsoleted by the new release
  • update changelog
  • [ ] run spectool -g -S rust-ssh-key-dir.spec
  • [ ] run kinit your_fas_account@FEDORAPROJECT.ORG
  • [ ] run fedpkg new-sources $(spectool -S rust-ssh-key-dir.spec | sed 's:.*/::')
  • [ ] PR the changes in Fedora
  • [ ] once the PR merges to rawhide, merge rawhide into the other relevant branches (e.g. f40) then push those, for example:

    git checkout rawhide
    git pull --ff-only
    git checkout f40
    git merge --ff-only rawhide
    git push origin f40

  • [ ] on each of those branches run fedpkg build
  • [ ] once the builds have finished, submit them to bodhi, filling in:
  • rust-ssh-key-dir for Packages
  • selecting the build(s) that just completed, except for the rawhide one (which gets submitted automatically)
  • writing brief release notes like "New upstream release; see release notes at link to GitHub release"
  • leave Update name blank
  • Type, Severity and Suggestion can be left as unspecified unless it is a security release. In that case select security with the appropriate severity.
  • Stable karma and Unstable karma can be set to 2 and -1, respectively.
  • [ ] submit a fast-track for FCOS testing-devel
  • [ ] submit a fast-track for FCOS next-devel if it is open

CentOS Stream 9 packaging:

• [ ] Create a rebase-c9s-ssh-key-dir issue in the internal team-operations repo and follow the steps there

[HuijingHei]

We need a new release for https://bugzilla.redhat.com/show_bug.cgi?id=2214223