Skip to content

Commit e4ea4e5

Browse files
Copilotneilime
authored andcommitted
docs: add Hoverkraft CI/CD methodology with GitHub Actions tutorial
1 parent 4ca502a commit e4ea4e5

22 files changed

Lines changed: 2490 additions & 170 deletions

.github/linters/.jscpd.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
{
22
"threshold": 5,
3-
"ignore": [".astro/**"]
3+
"ignore": [
4+
"**/.astro/**",
5+
"**/node_modules/**",
6+
"**/application/.docusaurus/**",
7+
"**/application/build/**"
8+
]
49
}

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ This command generates static content into the `build` directory and can be serv
3939

4040
```
4141
├──application/
42-
├── blog/ # Blog posts
4342
├── docs/ # Documentation pages
4443
├── src/ # Source files (React components, pages, etc.)
4544
│ ├── components/ # React components

application/blog/2019-05-28-first-blog-post.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

application/blog/2019-05-29-long-blog-post.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

application/blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 24 deletions
This file was deleted.
-93.9 KB
Binary file not shown.

application/blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

application/blog/authors.yml

Lines changed: 0 additions & 25 deletions
This file was deleted.

application/blog/tags.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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

Comments
 (0)