Skip to content
This repository was archived by the owner on Dec 2, 2025. It is now read-only.

Commit fcde738

Browse files
authored
Update version number (#21)
* update relese instructions and Cargo.toml * version number, release notes
1 parent 52bb919 commit fcde738

2 files changed

Lines changed: 14 additions & 13 deletions

File tree

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ strict = []
55

66
[package]
77
name = "ndelement"
8-
version = "0.0.1-dev"
8+
version = "0.1.0"
99
edition = "2021"
10-
authors = ["Timo Betcke <timo.betcke@gmail.com>", "Srinath Kailasa <srinathkailasa@gmail.com>", "Matthew Scroggs <rust@mscroggs.co.uk>"]
10+
authors = ["Matthew Scroggs <rust@mscroggs.co.uk>"]
1111
description = "n-dimensional finite element definition library."
1212
license = "BSD-3-Clause"
1313
homepage = "https://github.com/bempp/ndelement"

RELEASE.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Making a release
22

3-
To make a new release of ndgrid, follow the following steps:
3+
To make a new release of ndelement, follow the following steps:
44

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

8-
1) Checkout the branch `release` and merge the branch `main` into the branch `release`:
8+
1) Checkout the `main` branch and `git pull`, then checkout a new branch called `release-v[x].[y].[z]`
9+
(where `[x]`, `[y]`, and `[z]` are defined in the next step):
910
```bash
10-
git checkout release
11-
git merge main
11+
git checkout main
12+
git pull
13+
git checkout -b release-v[x].[y].[z]
1214
```
1315

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

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

22-
5) Commit your changes and push to GitHub. Wait to see if the CI tests pass.
23-
24-
6) [Create a release on GitHub](https://github.com/bempp/ndgrid/releases/new) from the `release` branch.
25+
4) [Create a release on GitHub](https://github.com/bempp/ndelement/releases/new) from the `main` branch.
2526
The release tag and title should be `v[x].[y].[z]` (where `[x]`, `[y]` and `[z]` are as in step 2).
2627
In the "Describe this release" box, you should bullet point the main changes since the last
2728
release.
2829

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

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

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

0 commit comments

Comments
 (0)