Skip to content

docs: DISTRIBUTION_SETUP secrets runbook complete (#63)#122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ulises-jeremias merged 1 commit into from
Jul 16, 2026
Merged

docs: DISTRIBUTION_SETUP secrets runbook complete (#63) #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 23 additions & 13 deletions docs/DISTRIBUTION_SETUP.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
# Distribution Setup
# Distribution Channels — One-Time Setup

Secrets and publishers (see also #58–#63):
`create-awesome-python-app` publishes on release tags (`create-awesome-python-app@X.Y.Z`):

| Channel | Secret / config |
|---------|-----------------|
| PyPI | Trusted Publishing OIDC (no long-lived token) |
| Docker Hub | `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN` |
| AUR | `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN` |
| Homebrew | `HOMEBREW_TAP_TOKEN` |
| Channel | Workflow | Secret(s) |
|---------|----------|-----------|
| **PyPI** | `publish.yml` | OIDC Trusted Publishing (no token) |
| **Docker** | `publish-docker.yml` | `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN` |
| **AUR** | `publish-aur.yml` | `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN` |
| **Homebrew** | `notify-homebrew.yml` | `HOMEBREW_TAP_TOKEN` |

Configure secrets under **Settings → Secrets and variables → Actions**.

## PyPI Trusted Publishing

1. Create a Trusted Publisher on PyPI for `create-awesome-python-app`
2. Repository: `Create-Python-App/create-python-app`
3. Workflow: `publish.yml`
4. No `PYPI_TOKEN` secret required when using OIDC
1. On PyPI, add a Trusted Publisher for project `create-awesome-python-app`
2. Owner/repo: `Create-Python-App/create-python-app`
3. Workflow name: `publish.yml`
4. Environment: (optional)

## Docker Hub

Create a write token and set `DOCKERHUB_USERNAME` / `DOCKERHUB_TOKEN`.

## AUR

Track sibling repo `Create-Python-App/aur-package` when ready. Secrets: `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN`.
Bootstrap PKGBUILD in a future `Create-Python-App/aur-package` mirror; set SSH key secret.

## Homebrew

Create `Create-Python-App/homebrew-tap` and allow `repository_dispatch` with `HOMEBREW_TAP_TOKEN`.
Loading