diff --git a/Cargo.toml b/Cargo.toml index de0a8c0..8730a77 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,10 +2,12 @@ nightly = ["pulp/nightly"] # Treat warnings as a build error. strict = [] +sleef = ["rlst/sleef"] +default = ["sleef"] [package] name = "green-kernels" -version = "0.2.0" +version = "0.2.1" edition = "2021" authors = ["Timo Betcke ", "Matthew Scroggs "] description = "Evaluation of Green's function kernels." @@ -27,7 +29,7 @@ approx = { version = "0.5", features = ["num-complex"] } rayon = "1.9" num = "0.4" num_cpus = "1" -rlst = { version = "0.2", features = ["sleef"] } +rlst = { version = "0.2" } rand = "0.8.5" itertools = { version = "0.13.0", default-features = false } coe-rs = "0.1.2" diff --git a/RELEASE.md b/RELEASE.md index cfea8e9..d35e8c8 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -5,10 +5,12 @@ To make a new release of green-kernels, 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,21 +19,19 @@ To make a new release of green-kernels, 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]`. -3) Commit your changes and push to GitHub, and check that all the tests on CI pass. - 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. -4) Commit your changes and push to GitHub, and check that all the tests on CI pass. - -5) [Create a release on GitHub](https://github.com/bempp/green-kernels/releases/new) from the `release` branch. +4) [Create a release on GitHub](https://github.com/bempp/green-kernels/releases/new) from the `release` 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. -6) 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. -7) 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. -8) 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`