https://github.com/juanvilla424/github-cicd-template
Github CICD Template Repository - https://template.bridgefusion.icu
https://github.com/juanvilla424/github-cicd-template
base baseline cicd docs github template
Last synced: 3 months ago
JSON representation
Github CICD Template Repository - https://template.bridgefusion.icu
- Host: GitHub
- URL: https://github.com/juanvilla424/github-cicd-template
- Owner: JuanVilla424
- License: gpl-3.0
- Created: 2024-10-19T01:45:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T17:05:32.000Z (about 1 year ago)
- Last Synced: 2025-03-10T17:05:38.976Z (about 1 year ago)
- Topics: base, baseline, cicd, docs, github, template
- Language: TypeScript
- Homepage: https://template.bridgefusion.icu/
- Size: 200 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 📄 GitHub CI/CD Template
Welcome to the **GitHub CI/CD Template** repository! This project provides a robust and flexible CI/CD pipeline setup using GitHub Actions, tailored for project using Python for backend, node frontend, docker-compose or Dockerfile. Leverage this template to automate your development workflow, from testing and building to deployment and monitoring.
## 📚 Table of Contents
- [Features](#-features)
- [Getting Started](#-getting-started)
- [Prerequisites](#-prerequisites)
- [Installation](#-installation)
- [Environment Setup](#-environment-setup)
- [Pre-Commit Hooks](#-pre-commit-hooks)
- [Extra Steps](#-extra-steps)
- [Usage](#-usage)
- [Contributing](#-contributing)
- [License](#-license)
- [Contact](#-contact)
## 🌟 Features
- **Automated Testing:** Run tests automatically on each push and pull request.
- **Continuous Deployment:** Deploy your application seamlessly to your chosen platform.
- **Code Quality Checks:** Enforce coding standards with linting and formatting tools.
- **Build Optimization:** Optimize build processes for faster deployment cycles.
- **Notifications:** Receive updates and alerts on pipeline status via email or chat integrations.
- **Automated Version Control:** Automatic version bumping, tagging, and promotion across branches (dev → test → prod → main).
- **Automated Release Notes:** GitHub Releases with categorized changelogs generated from conventional commits (Features, Bug Fixes, Refactors, etc.).
- **Changelog Generation:** Automatic CHANGELOG.md updates on every version bump via pre-commit hooks.
## 🚀 Getting Started
### 📋 Prerequisites
**Before you begin, ensure you have met the following requirements**:
- **GitHub Account:** You need a GitHub account to use GitHub Actions.
- **Python 3.12+:** Ensure Python is installed on your local machine.
- **Git:** Install [Git](https://git-scm.com/) to clone the repository.
- **NVM:** (Optional) Node.js installation environment versions control
- **Node.js 22.x+**: (Optional) (Required to Push) Used as lint orchestration manager in pre-commit and pre-push
### 🔨 Installation
1. **Clone the Repository**
```bash
git clone https://github.com/JuanVilla424/github-cicd-template.git
```
2. Navigate to the Project Directory
```bash
cd github-cicd-template
```
### 🔧 Environment Setup
**Mandatory: Setting Up a Python Virtual Environment**
Setting up a Python virtual environment ensures that dependencies are managed effectively and do not interfere with other projects.
1. **Create a Virtual Environment**
```bash
python -m venv venv
```
2. **Activate the Virtual Environment**
On Unix or MacOS:
```bash
source venv/bin/activate
```
On Windows:
```bash
.\venv\Scripts\activate
```
- or
```bash
powershell.exe -ExecutionPolicy Bypass -File .\venv\Scripts\Activate.ps1
```
3. **Upgrade pip**
```bash
pip install --upgrade pip
```
4. **Install Dependencies**
```bash
pip install -r requirements.txt
pip install poetry
poetry lock
poetry install
```
- Deactivate the Virtual Environment
When you're done, deactivate the environment:
```bash
deactivate
```
5. **Docker Extra Steps**: Install Scoop and then install hadolint using scoop, refer to [Extra Steps](#-extra-steps)
### 🛸 Pre-Commit Hooks
**Install and check pre-commit hooks**: MD files changes countermeasures, python format, python lint, yaml format, yaml lint, version control hook, changelog auto-generation
```bash
pre-commit install
pre-commit install -t pre-commit
pre-commit install -t pre-push
pre-commit autoupdate
pre-commit run --all-files
```
### 📌 Extra Steps
1. **Docker**:
- Using MacOs or Linux:
```bash
brew install hadolint
```
- On Windows **as non-admin user**:
```bash
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
scoop install hadolint
```
## 🛠️ Usage
**To utilize the CI/CD pipeline, follow these steps**:
1. **Configure GitHub Actions**
- Navigate to the .github/workflows/ directory.
- Customize the ci.yml file according to your project's requirements.
- Customize the python.yml file to format and lint python code.
- Customize the node.yml file to format and lint node.js code if you are hosting frontend.
- Customize the release-controller file to add or remove **[backend, frontend, docker deployment, database]**
2. **Set Up Secrets**
- Go to your GitHub repository settings.
- Navigate to Secrets and add necessary secrets like CODECOV_KEY, etc.
- Add `ACCESS_TOKEN` (Personal Access Token) for cross-repository submodule access and workflow triggers.
3. **Triggering the Pipeline**
- Push to Branches: Pushing code to dev, test, prod, or main branches will trigger the pipeline.
- Pull Requests: Opening or updating pull requests will run tests and checks.
4. **Version Bumping & Releases**
- Add `[patch candidate]`, `[minor candidate]`, or `[major candidate]` to your commit message to trigger a version bump.
- The pre-push hooks will automatically bump the version in `pyproject.toml` and amend the commit.
- The Version Controller workflow creates tags and promotion PRs across the branch chain (dev → test → prod → main).
- On main, a GitHub Release is automatically created with categorized release notes parsed from conventional commits.
5. **Monitoring Pipeline Status**
- Check the Actions tab in your GitHub repository to monitor the status of your workflows.
- Integrate notifications with Slack, Email, or other communication tools for real-time updates.
## 🤝 Contributing
**Contributions are welcome! To contribute to this repository, please follow these steps**:
1. **Fork the Repository**
2. **Create a Feature Branch**
```bash
git checkout -b feature/your-feature-name
```
3. **Commit Your Changes**
```bash
git commit -m "feat(): your feature commit message - lower case"
```
4. **Push to the Branch**
```bash
git push origin feature/your-feature-name
```
5. **Open a Pull Request into** `dev` **branch**
Please ensure your contributions adhere to the Code of Conduct and Contribution Guidelines.
### 🛠️ Adding a New Workflow
1. **Create a New Workflow File**
```bash
touch .github/workflows/new-workflow.yml
```
2. **Define the Workflow**
Customize the workflow according to your needs, using existing workflows as references.
3. **Commit and Push**
```bash
git add .github/workflows/new-workflow.yml
git commit -m "chore(core): added new workflow - lower case"
git push origin feature/your-feature-name
```
## 📫 Contact
For any inquiries or support, please open an issue or contact [r6ty5r296it6tl4eg5m.constant214@passinbox.com](mailto:r6ty5r296it6tl4eg5m.constant214@passinbox.com).
---
## 📜 License
2026 - This project is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). You are free to use, modify, and distribute this software under the terms of the GPL-3.0 license. For more details, please refer to the [LICENSE](LICENSE) file included in this repository.