-
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Remove spack testing * Fix indentation * Remove leading spaces
- Loading branch information
Showing
9 changed files
with
34 additions
and
293 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* Removed testing of spack package |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,50 +13,52 @@ The release of the `python-bindings` repository is made directly from a release | |
* `CHANGELOG.md` on `python-bindings-v2.1.1.1`. | ||
* There is no need to bump the version anywhere else, since we use the [python-versioneer](https://github.com/python-versioneer/python-versioneer/) for maintaining the version everywhere else. | ||
|
||
4. [Draft a New Release](https://github.com/precice/python-bindings/releases/new) in the `Releases` section of the repository page in a web browser. | ||
4. *Optional* test the [py-pyprecice Spack package](https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/py-pyprecice/package.py) using `spack dev-build py-pyprecice@develop`. | ||
|
||
5. [Draft a New Release](https://github.com/precice/python-bindings/releases/new) in the `Releases` section of the repository page in a web browser. | ||
|
||
* The release tag needs to be the exact version number (i.e.`v2.1.1.1` or `v2.1.1.1rc1`, compare to [existing tags](https://github.com/precice/python-bindings/tags)). | ||
* If this is a stable release, use `@target:master`. If this is a pre-release, use `@target:python-bindings-v2.1.1.1`. If you are making a pre-release, **directly skip to the [pre-release](#pre-release) section below**. | ||
* Release title is also the version number (i.e. `v2.1.1.1` or `v2.1.1.1rc1`, compare to [existing releases](https://github.com/precice/python-bindings/tags)). | ||
|
||
5. As soon as one approving review is made, merge the release PR (from `python-bindings-v2.1.1.1`) into `master`. | ||
|
||
6. Merge `master` into `develop` for synchronization of `develop`. | ||
|
||
7. If everything is in order up to this point then the new version can be released by hitting the "Publish release" button in your release Draft. This will create the corresponding tag and trigger [publishing the release to PyPI](https://github.com/precice/python-bindings/actions?query=workflow%3A%22Upload+Python+Package%22). | ||
|
||
8. Now there exists be a tag corresponding to the release on `master`. Re-run the [docker release workflow `build-docker.yml` via dispatch]([https://github.com/precice/fenics-adapter/actions/workflows/build-docker.yml](https://github.com/precice/python-bindings/actions/workflows/build-docker.yml)) such that the correct version is picked up by `versioneer`. Check the version in the container via `docker pull precice/python-bindings`, then `docker run -ti precice/python-bindings`, and inside the container `$ python3 -c "import precice; print(precice.__version__)"`. ⚠️ There is an open issue that needs fixing https://github.com/precice/python-bindings/issues/195 ⚠️ | ||
|
||
9. Add an empty commit (details https://github.com/precice/python-bindings/issues/109) on master by running the steps: | ||
6. As soon as one approving review is made, merge the release PR (from `python-bindings-v2.1.1.1`) into `master`. | ||
|
||
```bash | ||
git checkout master | ||
git commit --allow-empty -m "post-tag bump" | ||
git push | ||
``` | ||
7. Merge `master` into `develop` for synchronization of `develop`. | ||
|
||
Check that everything is in order via `git log`. Important: The `tag` and `origin/master` should not point to the same commit. For example: | ||
8. If everything is in order up to this point then the new version can be released by hitting the "Publish release" button in your release Draft. This will create the corresponding tag and trigger [publishing the release to PyPI](https://github.com/precice/python-bindings/actions?query=workflow%3A%22Upload+Python+Package%22). | ||
|
||
```bash | ||
commit 44b715dde4e3194fa69e61045089ca4ec6925fe3 (HEAD -> master, origin/master) | ||
Author: Benjamin Rodenberg <[email protected]> | ||
Date: Wed Oct 20 10:52:41 2021 +0200 | ||
9. Now there exists be a tag corresponding to the release on `master`. Re-run the [docker release workflow `build-docker.yml` via dispatch]([https://github.com/precice/fenics-adapter/actions/workflows/build-docker.yml](https://github.com/precice/python-bindings/actions/workflows/build-docker.yml)) such that the correct version is picked up by `versioneer`. Check the version in the container via `docker pull precice/python-bindings`, then `docker run -ti precice/python-bindings`, and inside the container `$ python3 -c "import precice; print(precice.__version__)"`. ⚠️ There is an open issue that needs fixing https://github.com/precice/python-bindings/issues/195 ⚠️ | ||
|
||
post-tag bump | ||
10. Add an empty commit (details https://github.com/precice/python-bindings/issues/109) on master by running the steps: | ||
|
||
commit d2645cc51f84ad5eda43b9c673400aada8e1505a (tag: v2.3.0.1) | ||
Merge: 2039557 aca2354 | ||
Author: Benjamin Rodenberg <[email protected]> | ||
Date: Tue Oct 19 12:57:24 2021 +0200 | ||
```bash | ||
git checkout master | ||
git commit --allow-empty -m "post-tag bump" | ||
git push | ||
``` | ||
|
||
Merge pull request #132 from precice/python-bindings-v2.3.0.1 | ||
Check that everything is in order via `git log`. Important: The `tag` and `origin/master` should not point to the same commit. For example: | ||
|
||
Release v2.3.0.1 | ||
``` | ||
```bash | ||
commit 44b715dde4e3194fa69e61045089ca4ec6925fe3 (HEAD -> master, origin/master) | ||
Author: Benjamin Rodenberg <[email protected]> | ||
Date: Wed Oct 20 10:52:41 2021 +0200 | ||
post-tag bump | ||
commit d2645cc51f84ad5eda43b9c673400aada8e1505a (tag: v2.3.0.1) | ||
Merge: 2039557 aca2354 | ||
Author: Benjamin Rodenberg <[email protected]> | ||
Date: Tue Oct 19 12:57:24 2021 +0200 | ||
Merge pull request #132 from precice/python-bindings-v2.3.0.1 | ||
Release v2.3.0.1 | ||
``` | ||
|
||
For more details refer to https://github.com/precice/python-bindings/issues/109 and https://github.com/python-versioneer/python-versioneer/issues/217. | ||
For more details refer to https://github.com/precice/python-bindings/issues/109 and https://github.com/python-versioneer/python-versioneer/issues/217. | ||
|
||
10. *Temporarily not maintained* Update Spack package (refer to `python-bindings/spack/README.md`). | ||
11. *Temporarily not maintained* Update the [py-pyprecice Spack package](https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/py-pyprecice/package.py). | ||
|
||
## Pre-release | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.