FIRSTRELEASE.md

Checklist for setting up releases

Follow the steps below in order to setup releases in a BikeNetKit repo with package PACKAGENAME.

Preliminaries

• All tested, commited, and merged on main
• Decide on a new version number X.Y.Z using semantic versioning. For a first release the recommended version is 0.1.0.

Setup pypi releases

On pypi

• pypi: Account settings > Your projects > Publishing > Add a new pending publisher > GitHub
  • PyPI Project Name: PACKAGENAME
  • Owner: BikeNetKit
  • Repository name: PACKAGENAME
  • Workflow name: publish.yml
  • Environment name: pypi

On Github

• Settings > Environments > New environment without extra configuration: pypi
• Pull requests > Labels > New label, color red: autorelease: tagged (the space is important!)
• Add and configure .github/workflows/publish.yml
• Add and configure setup.py
• Add and configure pyproject.toml
• Add and configure PACKAGENAME/__init__.py

Setup Github releases (with sphinx docs)

• Add and configure PACKAGENAME/_version.py
• Add and configure release-please-config.json
• Add and configure .release-please-manifest.json
• Add and configure docs/changelog.md
• Add and configure docs/conf.py

To make a new release, follow NEWRELEASE.md.