Updating Tags and Documentation

Updating Tags

For releases, perform these steps from master once the desired features have been merged in.

  1. Get latest tags:

    git pull --tags -f
  2. Tag your branch. Please use semantic versioning to name the tag; i.e., v<major>.<minor>.<patch>:

    git tag -f <tag-name> ## `-f` is required if updating an existing tag
  3. Push your tag upstream:

    git push origin --tags

Updating Documentation

Perform these steps from the root directory of the project.

  1. Create the directory where the generated files will be placed:

    mkdir -p site/api
  2. Run doxygen to generate API documentation:

    doxygen doxygen.conf
  3. Run mkdocs to deploy new documentation:

    mkdocs gh-deploy