This repository uses GitHub Actions for automated testing, linting, and deployment for Linux-based applications.

bash

CopyEdit

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pre-commit install

Run:

bash

CopyEdit

make check   # or
python cli.py check

Triggered on every push and pull_request:

• Lints code with flake8

• Checks formatting with black

• Runs tests using pytest

1. Create a feature branch:

   
   bash
   
   CopyEdit
   
   git checkout -b feature/xyz
   
   

2. Run checks locally:

   
   bash
   
   CopyEdit
   
   make check
   
   

3. Push and open a pull request.

4. GitHub Actions auto-runs the CI checks.

5. Only merge once:

   • ✅ All checks pass

   • ✅ Code is reviewed

• Main branch is protected.

• Rules:

  • ✅ Require status checks to pass

  • ✅ Require PR before merge

  • ✅ Optional: Require at least one reviewer

You can trigger a deployment workflow using GitHub Actions when pushing tags like v1.0.0.

yaml

CopyEdit

on:
  push:
    tags:
      - 'v*.*.*'
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: SSH Deploy
        run: ssh ${{ secrets.PROD_USER }}@${{ secrets.PROD_HOST }} << EOF
          cd /var/www/app
          git pull origin main
          sudo systemctl restart app.service
        EOF