From fcde738803f3a32d8b91cc6fad9867f11912ea81 Mon Sep 17 00:00:00 2001 From: Matthew Scroggs Date: Mon, 19 Aug 2024 09:08:31 +0100 Subject: [PATCH] Update version number (#21) * update relese instructions and Cargo.toml * version number, release notes --- Cargo.toml | 4 ++-- RELEASE.md | 23 ++++++++++++----------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 36dfba8..a79dd2e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,9 +5,9 @@ strict = [] [package] name = "ndelement" -version = "0.0.1-dev" +version = "0.1.0" edition = "2021" -authors = ["Timo Betcke ", "Srinath Kailasa ", "Matthew Scroggs "] +authors = ["Matthew Scroggs "] description = "n-dimensional finite element definition library." license = "BSD-3-Clause" homepage = "https://github.com/bempp/ndelement" diff --git a/RELEASE.md b/RELEASE.md index 9cc6686..17abfe9 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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`. @@ -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`