Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 2.63 KB

DEVELOPMENT.md

File metadata and controls

77 lines (56 loc) · 2.63 KB
Raw

Development

This document contains information regarding the development of PromAM.

Table of Contents

CI/CD

  • GitHub Actions is used.
  • Workflows are self-documenting.

Code Coverage

For code coverage, CodeCov is used. It is updated automatically as part of GitHub Actions. Notice that a coverage report must exist for the update to work.

Secrets

Secrets are stored as GitHub secrets in repository scope.

  • PYPI_TOKEN: Access to project PyPI registry. Used in release.yml.
  • TEST_PYPI_TOKEN: Access to project on PyPI test registry. Used in test-release.yml.

Documentation

Documentation is split into two parts. The autogenerated documentation and documentation created manually in specific Markdown files.

Autogenerated Docs

  • Pdoc3 is used for automatically generating an API documentation from Docstrings.
  • Generated data can be found in docs.
  • Code to build docs can be found in run.sh docs.
  • Automatically triggered on every commit to master branch.
  • Elements starting with an underscore are excluded.
  • GitHub Pages is used to host automatically generated docs.
    • Must be activated manually in GitHub repo settings.
    • /docs directory must be used.
    • Only latest commit on master branch is respected.

Manual Docs

Everything contained within README.md.

Questions & Answers

How to release a new version?

  1. Ensure that the commit workflow for the latest commit on master has been successful.
  2. Pick a new version number that follows the convention.
  3. Ensure that the changelog is up-to-date and follows the convention. The respective section will be extracted automatically.
  4. Ensure that the version is up-to-date in pyproject.toml.
  5. Run release workflow manually from GitHub UI.

How to change supported Python version(s)?

  1. Ensure that all tests are running successfully with (new) supported versions on your local machine.
  2. Update the Python dependency in pyproject.toml.
  3. Go through all workflow files and ensure that the correct versions are used.