README.md

repo-procedures

Checklists for repo management.

Repo Creation

• Create empty repo, with a description
• Create files from templates
  • License
    • MPL-2.0
    • Apache-2.0 OR MIT OR ZLib
      • Check MIT and ZLib date and copyright owner
  • .gitignore
    • Cargo.lock?
  • CHANGELOG.md
    • Change repo address and versions
  • README.tpl
    • Adjust repo address
  • .rustfmt.toml
  • deny.toml
  • Cargo.toml
    • Adjust everything as needed
• Setup CI
• Run cargo readme -o README.md then correct doc links and whitespace.
• Commit on branch trunk

CI Set Up

• Define MSRV
• Set MSRV in ci.yml
• Use and adjust ci.yml
• Mention MSRV in crate documenation.

Publish Version

• Update version numbers of all crates.
• Update in-crate documentation
• Run cargo readme -o README.md then correct doc links and whitespace.
• Update authors list
• Update keywords and categories if applicable
• Update CHANGELOG.md
  • Move all unreleased changes into section with new version.
  • Add new section to the table of contents
  • Add any missing changes. Use sections from https://keepachangelog.com/en/1.0.0/.
  • First thing in version section is: Released YYYY-MM-DD
  • Update diffs to include section from <old-version>..<new-version>
  • Update unreleased diff to <new-version>..HEAD
• Commit all changes and merge into trunk if needed
• Create a tag on trunk commit with full version info: v0.6.0.
• Push tag to github
• Create github release on that tag
  • Named v0.6.0 or v0.6.0 - Optional Quick Summary of Changes.
  • Copy changelog for release into body of gh release.
• Run through checklist again
• cargo workspace publish or series of cargo publish