-
Create a release branch with the release name, e.g.
release-2.0.0
and checkoutgit checkout -b release-2.0.0
-
Update version to, e.g. 2.0.0
- in
scout/__version__.py
- in
-
Make sure CHANGELOG.md is up to date for the release
-
Create a new blog post for the documentation
- in
scout/docs/blog/new-2.0.0.md
- Update
scout/docs/README.md
to include the blog post
- in
-
You can check the the new blog post looks as expected by running
mkdocs serve
. This way the updated pages will show in you browser if you open up the url written in the terminal (in general http://127.0.0.1:8000/ or http://0.0.0.0:4000/). Pages will rebuild automatically any time a change is introduced, so there is no need to run this command more than once. -
Commit changes, push to github and create a pull request
git add scout/__version__.py git add ... git commit -m "Release notes version 2.0.0" git push -u origin release-2.0.0
-
On github click "create pull request"
-
After getting the pull request approved by a reviewer merge it to master.
-
Draft a new release on GitHub, add some text - e.g. and abbreviated CHANGELOG - and release. This adds a version tag, builds and submits to PyPi.
-
Skip if using GitHub Action Pull the new version of master and tag the release:
git tag -a v2.0.0 -m "version 2.0.0 release" git push origin v2.0.0
-
build and publish docs (Make sure no unwanted files are added when doing
git add .
, rungit status
first)mkdocs gh-deploy