Skip to content

Commit 6980a18

Browse files
Merge pull request #122 from Create-Python-App/fix/63-dist-docs
docs: DISTRIBUTION_SETUP secrets runbook complete (#63)
2 parents bd42cbb + e94f75d commit 6980a18

1 file changed

Lines changed: 23 additions & 13 deletions

File tree

docs/DISTRIBUTION_SETUP.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
1-
# Distribution Setup
1+
# Distribution Channels — One-Time Setup
22

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

5-
| Channel | Secret / config |
6-
|---------|-----------------|
7-
| PyPI | Trusted Publishing OIDC (no long-lived token) |
8-
| Docker Hub | `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN` |
9-
| AUR | `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN` |
10-
| Homebrew | `HOMEBREW_TAP_TOKEN` |
5+
| Channel | Workflow | Secret(s) |
6+
|---------|----------|-----------|
7+
| **PyPI** | `publish.yml` | OIDC Trusted Publishing (no token) |
8+
| **Docker** | `publish-docker.yml` | `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN` |
9+
| **AUR** | `publish-aur.yml` | `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN` |
10+
| **Homebrew** | `notify-homebrew.yml` | `HOMEBREW_TAP_TOKEN` |
11+
12+
Configure secrets under **Settings → Secrets and variables → Actions**.
1113

1214
## PyPI Trusted Publishing
1315

14-
1. Create a Trusted Publisher on PyPI for `create-awesome-python-app`
15-
2. Repository: `Create-Python-App/create-python-app`
16-
3. Workflow: `publish.yml`
17-
4. No `PYPI_TOKEN` secret required when using OIDC
16+
1. On PyPI, add a Trusted Publisher for project `create-awesome-python-app`
17+
2. Owner/repo: `Create-Python-App/create-python-app`
18+
3. Workflow name: `publish.yml`
19+
4. Environment: (optional)
20+
21+
## Docker Hub
22+
23+
Create a write token and set `DOCKERHUB_USERNAME` / `DOCKERHUB_TOKEN`.
1824

1925
## AUR
2026

21-
Track sibling repo `Create-Python-App/aur-package` when ready. Secrets: `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN`.
27+
Bootstrap PKGBUILD in a future `Create-Python-App/aur-package` mirror; set SSH key secret.
28+
29+
## Homebrew
30+
31+
Create `Create-Python-App/homebrew-tap` and allow `repository_dispatch` with `HOMEBREW_TAP_TOKEN`.

0 commit comments

Comments
 (0)