One time setup¶

These steps only need to be completed once after the project is first created.

GitHub repository¶

Settings → General:

Releases

• Enable release immutability

Pull Requests

• Allow merge commits
• Allow squash merging
• Allow rebase merging
• Automatically delete head branches

Settings → Branches → Add branch protection rule for the Default branch (main):

• Restrict deletions
• Require a pull request before merging
• Block force pushes

Renovate¶

Ensure the Renovate app is installed on your account, then enable it for smkent/safeway-coupons.

PyPI publishing¶

This project uses trusted publishing so no API tokens need to be stored as secrets.

1. On PyPI, add a (pending) trusted publisher in your Trusted Publisher Management settings:
   • Publisher: GitHub Actions
   • Owner: smkent
   • Repository: safeway-coupons
   • Workflow: release.yaml
   • Environment: pypi
2. Create the pypi environment in the GitHub repository: Settings → Environments → New environment → pypi
3. Publish a release by pushing a tag:

   git tag v0.1.0  # or your desired first version number
   git push --tags
   

Container registry (ghcr.io)¶

Enable write access for Actions:

Settings → Actions → General → Workflow permissions → Read and write permissions

GitHub Pages¶

Settings → Pages → Source → GitHub Actions