Skip to content

Commit d6ff568

Browse files
committed
docs: add README
1 parent 685ce58 commit d6ff568

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# shared-workflows
2+
3+
Reusable GitHub Actions workflows for makeitworkcloud repositories.
4+
5+
## Usage
6+
7+
Call a shared workflow from your repository:
8+
9+
```yaml
10+
name: OpenTofu
11+
12+
on:
13+
pull_request:
14+
branches:
15+
- main
16+
push:
17+
branches:
18+
- main
19+
20+
permissions:
21+
contents: read
22+
pull-requests: write
23+
24+
jobs:
25+
opentofu:
26+
uses: makeitworkcloud/shared-workflows/.github/workflows/opentofu.yml@main
27+
secrets:
28+
SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
29+
```
30+
31+
## Available Workflows
32+
33+
| Workflow | Description |
34+
|----------|-------------|
35+
| `opentofu.yml` | OpenTofu/Terraform CI/CD with plan comments and apply on merge |
36+
37+
## Container
38+
39+
All workflows use `ghcr.io/makeitworkcloud/runner:latest`.
40+
41+
See [images](https://github.com/makeitworkcloud/images) for container source and included tools.
42+
43+
## Repository Setup
44+
45+
1. Add `SOPS_AGE_KEY` secret (via tfroot-github or manually)
46+
2. Create caller workflow in `.github/workflows/`
47+
3. Ensure repository has required files (e.g., `Makefile` with expected targets)

0 commit comments

Comments
 (0)