docs: add modular usage guide and fix GITEA_TOKEN warning
- Added table showing which sections to use per project type - Fixed stale warning: "Do NOT use DEPLOY_TOKEN" → "Do NOT use GITEA_TOKEN"
This commit is contained in:
+10
-1
@@ -2,11 +2,20 @@
|
|||||||
|
|
||||||
A reusable reference for building CI pipelines, release automation, and installer packaging for Python-based applications hosted on Gitea. Extracted from a production project using Gitea Actions (GitHub Actions-compatible).
|
A reusable reference for building CI pipelines, release automation, and installer packaging for Python-based applications hosted on Gitea. Extracted from a production project using Gitea Actions (GitHub Actions-compatible).
|
||||||
|
|
||||||
|
**This is a modular reference — pick only the sections you need.** Not every project requires all build targets. Common combinations:
|
||||||
|
|
||||||
|
| Project type | Sections to use |
|
||||||
|
|---|---|
|
||||||
|
| Docker-only service | 1, 2 (docker job only), 7, 8 |
|
||||||
|
| Desktop app (Windows + Linux) | 1, 2, 3, 4, 5, 6, 8 |
|
||||||
|
| Desktop + Docker | All sections |
|
||||||
|
| Python library/CLI | 1, 2 (release job only), 8 |
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Gitea instance with Actions enabled
|
- Gitea instance with Actions enabled
|
||||||
- Runner(s) tagged `ubuntu-latest` (e.g., TrueNAS-hosted Gitea runners)
|
- Runner(s) tagged `ubuntu-latest` (e.g., TrueNAS-hosted Gitea runners)
|
||||||
- `DEPLOY_TOKEN` secret configured in the repository (Settings > Secrets). **Do NOT use `DEPLOY_TOKEN`** — it is a reserved name in Gitea and will be rejected by the UI and API.
|
- `DEPLOY_TOKEN` secret configured in the repository (Settings > Secrets). **Do NOT use `GITEA_TOKEN`** — it is a reserved name in Gitea and will be rejected by the UI and API.
|
||||||
|
|
||||||
## Pipeline Architecture
|
## Pipeline Architecture
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user