Skip to content

Commit

Permalink
Update version number (#21)
Browse files Browse the repository at this point in the history
* update relese instructions and Cargo.toml

* version number, release notes
  • Loading branch information
mscroggs authored Aug 19, 2024
1 parent 52bb919 commit fcde738
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ strict = []

[package]
name = "ndelement"
version = "0.0.1-dev"
version = "0.1.0"
edition = "2021"
authors = ["Timo Betcke <timo.betcke@gmail.com>", "Srinath Kailasa <srinathkailasa@gmail.com>", "Matthew Scroggs <rust@mscroggs.co.uk>"]
authors = ["Matthew Scroggs <rust@mscroggs.co.uk>"]
description = "n-dimensional finite element definition library."
license = "BSD-3-Clause"
homepage = "https://github.com/bempp/ndelement"
Expand Down
23 changes: 12 additions & 11 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Making a release

To make a new release of ndgrid, follow the following steps:
To make a new release of ndelement, follow the following steps:

0) If you are yet to make a release on your current computer, run `cargo login` and copy an API
key from https://crates.io/me

1) Checkout the branch `release` and merge the branch `main` into the branch `release`:
1) Checkout the `main` branch and `git pull`, then checkout a new branch called `release-v[x].[y].[z]`
(where `[x]`, `[y]`, and `[z]` are defined in the next step):
```bash
git checkout release
git merge main
git checkout main
git pull
git checkout -b release-v[x].[y].[z]
```

2) Update the version number in `Cargo.toml`.
Expand All @@ -17,20 +19,19 @@ To make a new release of ndgrid, follow the following steps:
If you are releasing a minor version, you should increment `[y]` and set `[z]`
to zero. If you are releasing a bugfix, you should increment `[z]`.

4) In `Cargo.toml`, check that the `rlst` dependency is at the latest version.
3) Commit your changes and push to GitHub, open a pull request to merge changes back into main, and merge the
pull request.

5) Commit your changes and push to GitHub. Wait to see if the CI tests pass.

6) [Create a release on GitHub](https://github.com/bempp/ndgrid/releases/new) from the `release` branch.
4) [Create a release on GitHub](https://github.com/bempp/ndelement/releases/new) from the `main` branch.
The release tag and title should be `v[x].[y].[z]` (where `[x]`, `[y]` and `[z]` are as in step 2).
In the "Describe this release" box, you should bullet point the main changes since the last
release.

7) Run `cargo publish --dry-run`, then run `cargo package --list` and
5) Run `cargo publish --dry-run`, then run `cargo package --list` and
check that no unwanted extras have been included in the release.

8) If everything is working as expected, run `cargo publish`. This will push the new version to
6) If everything is working as expected, run `cargo publish`. This will push the new version to
crates.io. Note: this cannot be undone, but you can use `cargo yank` to mark a version as
unsuitable for use.

9) Open a pull request to `main` to update the version number in `Cargo.toml` to `[x].[y].[z]-dev`
7) Open a pull request to `main` to update the version number in `Cargo.toml` to `[x].[y].[z]-dev`

0 comments on commit fcde738

Please sign in to comment.