Skip to content

Completing project setup

Tip

If you selected Enable documentation site during project creation, these instructions are also present in your new project along with links directly to your project's specific settings pages! To view:

  1. Start the local documentation server: poe docs

  2. In your browser:

    1. Open http://localhost:8000
    2. Navigate to Project Operations → One time setup

GitHub repository

Repository Settings → General:

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

Repository 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 your repository.

PyPI publishing

Only needed if your project will publish packages to PyPI

This template 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: <your-github-user>
    • Repository: <your-project-name>
    • Workflow: release.yaml
    • Environment: pypi
  2. Create the pypi environment in the GitHub repository: 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)

Only needed if your project will build and publish container images

Enable write access for Actions:

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

GitHub Pages

Only needed if your project will publish the documentation site

Repository Settings → Pages → Source → GitHub Actions