Skip to content

Commit

Permalink
docs: Add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
DJDuque committed Aug 23, 2024
1 parent 1604a50 commit 3de8ffd
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,32 @@ start working on a pull request. Additionally, please look at the GitHub actions
[workflows](https://github.com/ALPHA-g-Experiment/data-handler/tree/main/.github/workflows)
to find out all the checks that your code has to pass before it can be
reviewed/merged.

## Release Process

Once you have implemented all the fixes/features you want to release (make sure
you are on the main branch and it is up-to-date), you need to:

```bash
# Step 1: Make a new branch
git switch -c $NEW_BRANCH

# Step 2: Check all commits since the last release
cargo release changes

# Step 3: Update the `CHANGELOG.md` to include anything relevant that was missed
# Then commit the changes e.g.
git commit -am "docs: Update CHANGELOG.md"

# Step 4: Determine what the next version is (according to semver) and give
# `cargo-release` the pleasure of doing all the boring stuff
cargo release --execute --no-publish --no-tag --allow-branch=$NEW_BRANCH $NEW_VERSION

# Step 5: Open a pull request and review/merge to `main`

# Step 6: Release from the main branch
git checkout main
git pull
cargo release tag --execute
cargo release push --execute
```

0 comments on commit 3de8ffd

Please sign in to comment.