Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions docs/CPA_TEMPLATES_TRACKING.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Previously tracked by
- [x] `fastapi-starter` template + initial extensions
- [x] Wire catalog URL in CLI (`CPA_CATALOG_URL`, default raw GitHub URL)
- [x] Integration tests against `cpa-templates` checkout
- [x] Layered CI on `cpa-templates` (L0–L3) — always scaffold via `uvx` from PyPI ([cpa-templates#46](https://github.com/Create-Python-App/cpa-templates/issues/46))
- [ ] Website (optional, later)

## Repositories
Expand All@@ -20,6 +21,18 @@ Previously tracked by
| CLI monorepo | [create-python-app](https://github.com/Create-Python-App/create-python-app) |
| Template bank | [cpa-templates](https://github.com/Create-Python-App/cpa-templates) |

## CI contract (`cpa-templates`)

Template-bank CI **must** invoke the CLI as published on PyPI:

```sh
uvx create-awesome-python-app@latest …
```

It must **not** check out this monorepo or fall back to `uv run` against a local source tree. That way green Actions means the same binary users install works with the templates under test.

CLI CI in this repo stays focused on unit/lint/type/smoke-distribution (`uvx` / Docker / brew / AUR).

## CNA parity reference

| CNA | CPA |
Expand All@@ -28,3 +41,4 @@ Previously tracked by
| `cna-templates` | `cpa-templates` |
| `cna.config.json` | `cpa.config.json` |
| `~/.cache/cna` | `~/.cache/cpa` |
| Layered L0–L3 CI | Layered L0–L3 CI (`uvx` / PyPI) |
9 changes: 9 additions & 0 deletions docs/TROUBLESHOOTING.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -365,3 +365,12 @@ uvx create-awesome-python-app@latest --version
If behavior differs between `uvx` and a global install, compare versions and
clear the uv tool cache. See [DISTRIBUTION_SETUP.md](./DISTRIBUTION_SETUP.md) for
maintainer release workflow.

### `cpa-templates` CI contract

The template bank CI scaffolds exclusively with `uvx create-awesome-python-app@latest`
(PyPI). It does not check out this monorepo as a scaffolding fallback. If template
CI fails after a CLI release, fix/publish the CLI — do not teach template CI to
`uv run` against source. See
[cpa-templates#46](https://github.com/Create-Python-App/cpa-templates/issues/46)
and [CPA_TEMPLATES_TRACKING.md](./CPA_TEMPLATES_TRACKING.md).