glotzerlab / glotzerlab/row

Release 1.1.0

Open
#412 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
19
Forks
1
Avg merge
1h 11m
Merged PRs (30d)
17

Description

To make a new row release:

  • Make a new release-{X.Y.Z} branch (where {X.Y.Z} is the new version).

On that branch, take the following steps (committing after each step when needed):

  • Run prek autoupdate.
  • Check for new or duplicate contributors since the last release:
    comm -13 (git log $(git describe --tags --abbrev=0) --format="%aN <%aE>" | sort | uniq | psub) (git log --format="%aN <%aE>" | sort | uniq | psub).
    Add entries to .mailmap to remove duplicates.
  • Review release-notes.md and revise if needed.
  • Add highlights to release notes.
  • Run bump-my-version bump {type}. Replace {type} with:
    • patch when this release only includes bug fixes.
    • minor when this release includes new features and possibly bug fixes.
    • major when this release includes API breaking changes.
  • Run cargo check
  • Run cargo update
  • Run cargo bundle-licenses --format yaml --output THIRDPARTY.yaml
  • Push the branch and open a pull request.
  • Check that readthedocs builds the docs correctly in the pull request checks.
  • Merge the pull request after all tests pass.
  • Make a new tag on the trunk branch:
    git switch trunk
    git pull
    git tag -a {X.Y.Z}
    git push origin --tags
    

[!IMPORTANT]
Make sure to exclude v from the tag name!

  • Add a blank release notes entry for the next release:
    ## Next release
    
    *Added:*
    
    *Changed:*
    
    *Deprecated:*
    
    *Removed:*
    
    *Fixed:*
    

[!NOTE]
Paste Next release exactly as shown. bump-my-version will replace that
string with the version number and date.

GitHub Actions will trigger on the tag and upload the release to crates.io and create a
GitHub release. After a few hours, the conda-forge autotick bot will submit a PR
for the new release.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the open conda-forge recipe task after reviewing the completed release checklist. Check whether the recipe needs updates, such as dependency changes, before merging it. Done means the conda-forge recipe is updated if necessary and merged; the GitHub release and crates.io upload are already marked as verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions, rust
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.