|
| 1 | +--- |
| 2 | +sidebar_position: 1 |
| 3 | +--- |
| 4 | + |
| 5 | +# Getting Started with GitHub Actions CI/CD |
| 6 | + |
| 7 | +Set up CI/CD for your project using GitHub Actions and Hoverkraft reusable workflows. The pattern works for single applications, monorepos, and containerized services alike—adjust the working directory and build steps to match your stack. |
| 8 | + |
| 9 | +## What You'll Build |
| 10 | + |
| 11 | +✅ Automated testing on pull requests |
| 12 | +✅ Automated builds on commits |
| 13 | +✅ On-demand deployments (review apps via `/deploy` comments, production via manual release workflow) |
| 14 | +✅ Community automation (semantic PR titles, greetings, stale issues) |
| 15 | +✅ Security scanning via the shared CI workflow |
| 16 | + |
| 17 | +## Prerequisites |
| 18 | + |
| 19 | +- GitHub repository (public or private) containing your application code |
| 20 | +- Deterministic build/test commands (Makefile targets, package scripts, or similar) |
| 21 | +- Ability to configure workflow inputs for your stack (working directory, runtime version, artifacts) |
| 22 | +- Basic Git/GitHub knowledge |
| 23 | +- ~30-60 minutes |
| 24 | + |
| 25 | +## CI/CD Overview |
| 26 | + |
| 27 | +**Continuous Integration (CI)**: Automatically builds, lints, and checks code on every change |
| 28 | +**Continuous Deployment (CD)**: Deploys once you trigger it—either `/deploy` for review apps or a manual release workflow after CI succeeds |
| 29 | + |
| 30 | +## Hoverkraft Approach |
| 31 | + |
| 32 | +Pre-built, reusable workflows that: |
| 33 | + |
| 34 | +- Centralise CI logic in `__shared-ci.yml` so every workflow reuses the same jobs |
| 35 | +- Enforce best practices (version pinning, minimal permissions) |
| 36 | +- Stay updated through Dependabot (actions, runtimes, base images) |
| 37 | + |
| 38 | +## Tutorial Steps |
| 39 | + |
| 40 | +1. **Project Structure** - Repository layout |
| 41 | +2. **Core Workflows** - Essential CI/CD |
| 42 | +3. **Community Workflows** - Optional automation |
| 43 | +4. **Deployment** - On-demand deployment flows |
| 44 | +5. **Testing** - Verification |
| 45 | +6. **Best Practices** - Tips and guidelines |
| 46 | + |
| 47 | +Follow steps in order for best results. |
| 48 | + |
| 49 | +## Ready? |
| 50 | + |
| 51 | +👉 **Next: [Project Structure →](./02-project-structure.md)** |
| 52 | + |
| 53 | +--- |
| 54 | + |
| 55 | +💡 **Tip**: Implement gradually - start with core workflows, test, then expand |
0 commit comments