-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
0 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
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>` |