Skip to content

Commit

Permalink
Add guide for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mjwen committed Mar 2, 2022
1 parent 5e241fb commit 07dca5b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions devtool/release_new_version.md
Original file line number Diff line number Diff line change
@@ -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<major><minor><patch>`

0 comments on commit 07dca5b

Please sign in to comment.