Skip to content

Commit 34bc449

Browse files
docs: cpa-templates layered CI must use uvx from PyPI (#192)
Document that cpa-templates CI scaffolds only via uvx from PyPI (no source fallback).
1 parent 857d916 commit 34bc449

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

docs/CPA_TEMPLATES_TRACKING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Previously tracked by
1111
- [x] `fastapi-starter` template + initial extensions
1212
- [x] Wire catalog URL in CLI (`CPA_CATALOG_URL`, default raw GitHub URL)
1313
- [x] Integration tests against `cpa-templates` checkout
14+
- [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))
1415
- [ ] Website (optional, later)
1516

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

24+
## CI contract (`cpa-templates`)
25+
26+
Template-bank CI **must** invoke the CLI as published on PyPI:
27+
28+
```sh
29+
uvx create-awesome-python-app@latest …
30+
```
31+
32+
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.
33+
34+
CLI CI in this repo stays focused on unit/lint/type/smoke-distribution (`uvx` / Docker / brew / AUR).
35+
2336
## CNA parity reference
2437

2538
| CNA | CPA |
@@ -28,3 +41,4 @@ Previously tracked by
2841
| `cna-templates` | `cpa-templates` |
2942
| `cna.config.json` | `cpa.config.json` |
3043
| `~/.cache/cna` | `~/.cache/cpa` |
44+
| Layered L0–L3 CI | Layered L0–L3 CI (`uvx` / PyPI) |

docs/TROUBLESHOOTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,3 +365,12 @@ uvx create-awesome-python-app@latest --version
365365
If behavior differs between `uvx` and a global install, compare versions and
366366
clear the uv tool cache. See [DISTRIBUTION_SETUP.md](./DISTRIBUTION_SETUP.md) for
367367
maintainer release workflow.
368+
369+
### `cpa-templates` CI contract
370+
371+
The template bank CI scaffolds exclusively with `uvx create-awesome-python-app@latest`
372+
(PyPI). It does not check out this monorepo as a scaffolding fallback. If template
373+
CI fails after a CLI release, fix/publish the CLI — do not teach template CI to
374+
`uv run` against source. See
375+
[cpa-templates#46](https://github.com/Create-Python-App/cpa-templates/issues/46)
376+
and [CPA_TEMPLATES_TRACKING.md](./CPA_TEMPLATES_TRACKING.md).

0 commit comments

Comments
 (0)