Your lib name

Overview

🚧 Clear brief of your lib

Python versions support

🚧 The required Python versions of this library

[](https://pypi.org/project/)

Quickly Start

🚧 The details of quickly start as simple demonstration for users

Documentation

🚧 The details of documentation ...

Reusable GitHub Actions Workflows & Actions

This template provides a comprehensive set of reusable GitHub Actions workflows and actions that can be called from other repositories to standardize CI/CD operations. Projects using this template can leverage these centralized components for consistent automation.

🚀 Key Features

• Centralized Management: All workflows and actions are maintained in this template repository
• Standardized Operations: Consistent CI/CD processes across all projects
• Easy Integration: Simple calls using external repository references
• Comprehensive Coverage: Testing, building, releasing, Docker operations, documentation, and setup utilities

📋 Available Workflows

Workflow	Purpose	Key Features
rw_build_and_test.yaml	Run comprehensive test suite	Unit, integration, e2e, contract tests
rw_run_all_test_and_record.yaml	Complete CI with reporting	CodeCov upload, SonarCloud analysis
rw_python_package.yaml	Python package operations	Build, test, publish to PyPI
rw_docker_operations.yaml	Docker operations	Build, test, push, security scanning
rw_parse_release_intent.yaml	Release configuration parser	Determines release components
rw_build_git-tag_and_create_github-release_v2.yaml	Git tagging and releases	Automated version management
rw_docs_operations.yaml	Documentation operations	Build, version, deploy docs

📦 Available Actions

Action	Purpose	Key Features
setup-python-uv	Python & UV setup with dependencies	Multi-version support, intelligent caching, flexible dependency groups

🔧 Quick Start

To use these reusable workflows in your project, simply call them using external repository references:

# .github/workflows/ci.yaml in your project
name: CI
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_run_all_test_and_record.yaml@master
    secrets:
      codecov_token: ${{ secrets.CODECOV_TOKEN }}
      sonar_token: ${{ secrets.SONAR_TOKEN }}

📚 Complete Documentation

• Reusable Workflows Guide: Complete documentation with all inputs, outputs, and usage examples
• Example Workflows: Ready-to-use example workflows for common scenarios
• Template Placeholders: All workflows use <your_*> placeholders for easy customization

💡 Benefits for Projects Using This Template

1. Reduced Boilerplate: No need to write complex CI/CD workflows from scratch
2. Best Practices: Workflows follow established patterns and security practices
3. Automatic Updates: Bug fixes and improvements are centrally maintained
4. Consistency: Same workflow behavior across all projects using the template
5. Easy Maintenance: Update workflows in one place, benefits all projects

Coding style and following rules

follows coding styles black and PyLint to control code quality.

Downloading state

🚧 The download state for your library

[](https://pepy.tech/project/) [](https://pepy.tech/project/)

License

MIT License