From cb1b59fcb4d6d7be0f676ff022ba6c428e3165eb Mon Sep 17 00:00:00 2001 From: Jusong Yu Date: Tue, 16 Aug 2022 19:03:14 +0200 Subject: [PATCH] Update README of how to release for maintainers (#374) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2aa061df..95a95f3d 100644 --- a/README.md +++ b/README.md @@ -150,3 +150,10 @@ To learn more about this, see the [`optimade-python-tools`](https://github.com/M **Q: Why create an individual `config.json` file instead of just mounting an existing `.aiida` directory and using that directly?** **A:** This, currently, wouldn't work because the `REPOSITORY_URI` needs to point to the right path *inside* the container, not on the host. Furthermore, storing all configurations in the same file can be fragile. + +## For maintainers + +To release the new version, go to GitHub release API of the repo create a new release and update the release information. +The release action will be triggered by newly created release. +Note, the tag should start with a `v` and be followed by a full semantic version (see [SemVer](https://semver.org)). +For example: `v2.3.12`.