Skip to content

Commit da7b10e

Browse files
committed
➕ Add each workflow running state and its reference links for the common repo.
1 parent b541eaa commit da7b10e

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs_with_docusarus/contents/development/ci-cd/release-system.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,35 @@ sidebar_position: 3
77

88
The release workflows for this template are now maintained in the centralized repository `Chisanan232/GitHub-Action_Reusable_Workflows-Python`. This project consumes those reusable workflows for production, validation, and staging releases while keeping only minimal configuration locally.
99

10+
## Release workflows
11+
12+
### Production release (`release.yml`)
13+
[![Release](https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/release.yml/badge.svg)](https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/release.yml)
14+
15+
Publishes production artifacts (PyPI package, container images, docs) using the centralized `rw_release_complete.yaml` workflow logic.
16+
17+
:::note Documentation
18+
See the reusable workflow guide for production releases: [rw_release_complete.yaml](https://chisanan232.github.io/GitHub-Action_Reusable_Workflows-Python/docs/next/workflows/release/rw_release_complete) (hosted in `Chisanan232/GitHub-Action_Reusable_Workflows-Python`).
19+
:::
20+
21+
### Release staging (`release-staging.yml`)
22+
[![Release Staging](https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/release-staging.yml/badge.svg)](https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/release-staging.yml)
23+
24+
Creates staging/TestPyPI packages, RC container images, and preview documentation to test releases before production.
25+
26+
:::note Documentation
27+
Reusable staging workflow reference: [rw_release_staging_complete.yaml](https://chisanan232.github.io/GitHub-Action_Reusable_Workflows-Python/docs/next/workflows/release/rw_release_staging_complete).
28+
:::
29+
30+
### Release validation (`release-validate.yml`)
31+
[![Release Validation](https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/release-validate.yml/badge.svg)](https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/release-validate.yml)
32+
33+
Dry-runs the release pipeline for pull requests, verifying builds and security checks without publishing artifacts.
34+
35+
:::note Documentation
36+
Reusable validation workflow details: [rw_release_validation_complete.yaml](https://chisanan232.github.io/GitHub-Action_Reusable_Workflows-Python/docs/next/workflows/release/rw_release_validation_complete).
37+
:::
38+
1039
## Overview
1140

1241
- **Centralized logic**: All release orchestration lives in the reusable workflow repository.

0 commit comments

Comments
 (0)