Skip to content

GITHUB_ACTIONS_QUICK_START.md

Latest commit

 

History

History
154 lines (114 loc) · 4.55 KB

GITHUB_ACTIONS_QUICK_START.md

File metadata and controls

154 lines (114 loc) · 4.55 KB

GitHub Actions Quick Setup - 5 Minutes

🎯 What Was Added

You now have 5 professional CI/CD workflows that automatically:

  • ✅ Test your code on every push
  • ✅ Check code quality & security
  • ✅ Build Docker images automatically
  • ✅ Deploy documentation
  • ✅ Publish releases

⚡ Quick Setup (Required - 2 minutes)

Step 1: Add GitHub Secrets

Go to: https://github.com/surukanti/distributed-task-queue-python/settings/secrets/actions

Optional but recommended:

DOCKER_USERNAME = your_dockerhub_username
DOCKER_PASSWORD = your_dockerhub_token

(Skip if you don't want to publish Docker images)

Step 2: Enable GitHub Pages (for docs)

Go to: https://github.com/surukanti/distributed-task-queue-python/settings/pages

  • Select: Branch = gh-pages
  • Select: Folder = / (root)
  • Click Save

That's it! Your workflows are now active! 🚀

📊 What Happens Automatically Now

Event Workflow Action
git push CI Run tests, lint, security scan
Pull Request CI Test and lint before merge
git push + secrets Docker Build and push images
git tag v1.0.0 Release Create GitHub release
git tag v1.0.0 Docker Build Docker with version tag
git tag v1.0.0 PyPI Publish Python package

📈 Monitor Your Workflows

  1. Go to: https://github.com/surukanti/distributed-task-queue-python/actions
  2. See all workflow runs
  3. Click any run to see logs

🏷️ Create Your First Release

# Create a release tag
git tag -a v1.0.0 -m "Initial release"

# Push it
git push origin v1.0.0

# Go to Actions tab to watch it build!

📚 Workflows Overview

Workflow Trigger Time Cost
CI Every push ~2 min Free
Docker Every push ~5 min Free
Quality Every push ~3 min Free
Docs Push to main ~1 min Free
Release Version tag ~10 min Free

🎨 Add Status Badges to README

Copy this into your README.md:

## CI/CD Status

[![CI - Tests & Linting](https://github.com/surukanti/distributed-task-queue-python/workflows/CI%20-%20Tests%20%26%20Linting/badge.svg)](https://github.com/surukanti/distributed-task-queue-python/actions/workflows/ci.yml)
[![Docker Build & Push](https://github.com/surukanti/distributed-task-queue-python/workflows/Docker%20Build%20%26%20Push/badge.svg)](https://github.com/surukanti/distributed-task-queue-python/actions/workflows/docker.yml)
[![Code Quality & Analysis](https://github.com/surukanti/distributed-task-queue-python/workflows/Code%20Quality%20%26%20Analysis/badge.svg)](https://github.com/surukanti/distributed-task-queue-python/actions/workflows/quality.yml)

📁 Files Added

.github/workflows/
├── ci.yml              # Tests, linting, security
├── docker.yml          # Docker image build & push
├── quality.yml         # Code analysis & complexity
├── docs.yml            # Documentation deployment
└── release.yml         # Release management
.pre-commit-config.yaml # Local git hooks
setup.py               # PyPI package config
pyproject.toml         # Project metadata
sonar-project.properties # SonarCloud config
GITHUB_ACTIONS_GUIDE.md # Detailed guide

🔗 Useful Links

Resource Link
GitHub Actions Docs https://docs.github.com/en/actions
Docker Hub https://hub.docker.com/settings/security
PyPI https://pypi.org/account/
SonarCloud (optional) https://sonarcloud.io
Codecov (optional) https://codecov.io

❓ FAQ

Q: Why are my workflows not running? A: Check Settings → Actions → General → Allow all actions and reusable workflows

Q: Do I need to add secrets? A: No, but without them Docker images won't be pushed. Tests will still run.

Q: How do I see what failed? A: Go to Actions tab → Click failed workflow → See logs

Q: Can I customize the workflows? A: Yes! Edit files in .github/workflows/ directory

Q: How much does this cost? A: GitHub Actions is free for public repos!

🚀 Pro Tips

  1. Local testing before push:

    pip install pre-commit
pre-commit install
pre-commit run --all-files

  2. View workflow status:

    gh workflow list
gh run list

  3. Semantic versioning:

    git tag v1.0.0   # Major release
git tag v1.0.1   # Patch release
git tag v1.1.0   # Minor release

You're all set! Your project now has professional CI/CD. 🎉

Next: Push some code and watch the workflows run!