Skip to content

Commit

Permalink
chore: adds initial RELEASE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
claymcleod committed Sep 8, 2024
1 parent 1bba842 commit a4d48d9
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Release

- [ ] Update version in `Cargo.toml`.
- [ ] Update `CHANGELOG.md` with version and publication date.
- To get the changes to the crate since the last release, you can use a
command like the following:
```bash
git log tes-v0.1.0..HEAD --oneline
```
- [ ] Run tests: `cargo test --all-features`.
- [ ] Run linting: `cargo clippy --all-features`.
- [ ] Run fmt: `cargo +nightly fmt --check`.
- [ ] Run doc: `cargo doc`.
- [ ] Stage changes: `git add Cargo.toml CHANGELOG.md`.
- [ ] Create git commit:
```
git commit -m "release: bumps `tes` version to v0.1.0"
```
- [ ] Create git tag:
```
git tag tes-v0.1.0
```
- [ ] Push release: `git push && git push --tags`.
- [ ] Go to the Releases page in Github, create a Release for this tag, and
copy the notes from the `CHANGELOG.md` file.

0 comments on commit a4d48d9

Please sign in to comment.