From 07dca5bb6d43be3520a7dc42b3572103593cdfa3 Mon Sep 17 00:00:00 2001 From: mjwen Date: Tue, 1 Mar 2022 20:57:30 -0800 Subject: [PATCH] Add guide for release --- devtool/release_new_version.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 devtool/release_new_version.md diff --git a/devtool/release_new_version.md b/devtool/release_new_version.md new file mode 100644 index 00000000..7a16b92e --- /dev/null +++ b/devtool/release_new_version.md @@ -0,0 +1,11 @@ +# Steps to release a new version + +- Change the version by modifying `major`, `minor` and `patch` in `./update_version.py` + and then `$ python update_version.py` +- Format code `$ python format_sources.py` +- Update docs at `kliff/docs/source` as necessary +- Update `kliff/docs/source/changelog.rst` +- Generate docs by running `$ make html` in the `kliff/docs` directory +- Commit and merge it to the `docs` branch. [ReadTheDocs](https://readthedocs.org) + is set up to watch this branch and will automatically generate the docs.) +- Go to GitHub and release a new version by tagging it with `v` \ No newline at end of file