Setting Up Release and Publish GitHub Action

Setting Up Release and Publish GitHub Action

Resources

• pypa/gh-action-pypi-publish
• PyPI token generation
• git tag

Examples

• spatialucr/geosnap
• pysal/spaghetti

General Workflow

• set up GHA - release in branch
  • generate PyPI api token
  • set up GH secret in origin & upstream
  • fill in / adjust workflow .yml as necessary
• create PR from origin --> upstream
• push tag to origin
• make sure everything passes and creates PyPI release
• merge upstream PR
• bump version once more and rebuild docs
• push commit of docs directly upstream
• push tag directly upstream

Creating a New Release

• push a tag with v prefix directly upstream. Thats it. (Make sure to push the tag directly upstream, otherwise you risk the workflow running on your personal fork, in which a pypi release will be created with the current version number. If that happens, the workflow will fail upstream because pypi will reject a package with the same version number