Skip to content

Releasing

Versioning

  1. Run the prepare release script and bump the desirable version part.
  2. If there are no errors git push && git push --tags.
  3. Wait for the CI server to upload the artifacts.
  4. Visit Sonatype Nexus and promote the artifacts.

Documentation updates

Website documentation lives under /docs directory and is deployed with MkDocs using Material Theme. A new site is built and published for the latest commits on the trunk branch.

If you want to test the website locally before pushing changes, you need to follow these steps.

Make sure you have Python 3 and pip installed.

$ python --version
Python 3.8.5

$ pip --version
pip 20.2.4

Install MkDocs, Material Theme and MkDocs Video.

$ pip install mkdocs mkdocs-material mkdocs-video
$ mkdocs --version
mkdocs, version 1.1.2

Navigate to the library directory and run the site locally.

$ mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 0.73 seconds
[I 201026 22:51:56 server:335] Serving on http://127.0.0.1:8000
INFO    -  Serving on http://127.0.0.1:8000