Skip to content

Commit e0a9c19

Browse files
committed
➕ Add more clear info like GitHub badges of important points.
1 parent 55aa94c commit e0a9c19

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ sidebar_position: 3
55

66
# Release System
77

8+
[![GitHub release](https://img.shields.io/github/v/release/Chisanan232/Template-Python-UV-Project?display_name=tag&color=24292e&logo=github)](https://github.com/Chisanan232/Template-Python-UV-Project/releases)
9+
810
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.
911

1012
## Release workflows
1113

1214
### Production release (`release.yml`)
1315
[![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)
16+
[![PyPI version](https://img.shields.io/pypi/v/test-python-uv-project-template?label=PyPI&color=306998&logo=pypi)](https://pypi.org/project/test-python-uv-project-template/)
1417

1518
Publishes production artifacts (PyPI package, container images, docs) using the centralized `rw_release_complete.yaml` workflow logic.
1619

@@ -41,6 +44,7 @@ See the reusable workflow guide for production releases: [rw_release_complete.ya
4144

4245
### Release staging (`release-staging.yml`)
4346
[![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)
47+
[![TestPyPI version](https://img.shields.io/badge/dynamic/json?label=TestPyPI&color=ff6600&query=%24.info.version&url=https%3A%2F%2Ftest.pypi.org%2Fpypi%2Ftest-python-uv-project-template%2Fjson&logo=pypi)](https://test.pypi.org/project/test-python-uv-project-template/)
4448

4549
Creates staging/TestPyPI packages, RC container images, and preview documentation to test releases before production.
4650

docs_with_docusarus/contents/development/coding-style.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ sidebar_position: 4
88

99
To maintain consistency and quality across the codebase, we follow these coding standards and rules. All contributors are expected to adhere to these guidelines.
1010

11+
[![pre-commit enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
12+
[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
13+
[![isort imports](https://img.shields.io/badge/imports-isort-ef8336?logo=python&logoColor=white)](https://pycqa.github.io/isort/)
14+
[![Flake8 linting](https://img.shields.io/badge/lint-flake8-4B8BBE)](https://flake8.pycqa.org/)
15+
[![MyPy type checking](https://img.shields.io/badge/types-mypy-2A6DB5)](https://mypy.readthedocs.io/en/stable/)
16+
[![Pylint linting](https://img.shields.io/badge/lint-pylint-ffcc00)](https://pylint.readthedocs.io/en/latest/)
17+
1118
## Python Code Style
1219

1320
### PEP 8

0 commit comments

Comments
 (0)