Skip to content

Commit 4febd8d

Browse files
committed
docs(README): update workflow documentation for modular config
1 parent 04036e7 commit 4febd8d

File tree

1 file changed

+2
-30
lines changed

1 file changed

+2
-30
lines changed

README.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -179,37 +179,9 @@ magex help
179179
<summary><strong><code>GitHub Workflows</code></strong></summary>
180180
<br/>
181181

182+
All workflows are driven by modular configuration in [`.github/env/`](.github/env/README.md) — no YAML editing required.
182183

183-
### The Workflow Control Center
184-
185-
All GitHub Actions workflows in this repository are powered by configuration files: [**.env.base**](.github/.env.base) (default configuration) and optionally **.env.custom** (project-specific overrides) – your one-stop shop for tweaking CI/CD behavior without touching a single YAML file! 🎯
186-
187-
**Configuration Files:**
188-
- **[.env.base](.github/.env.base)** – Default configuration that works for most Go projects
189-
- **[.env.custom](.github/.env.custom)** – Optional project-specific overrides
190-
191-
This magical file controls everything from:
192-
- **🚀 Go version matrix** (test on multiple versions or just one)
193-
- **🏃 Runner selection** (Ubuntu or macOS, your wallet decides)
194-
- **🔬 Feature toggles** (coverage, fuzzing, linting, race detection, benchmarks)
195-
- **🛡️ Security tool versions** (gitleaks, nancy, govulncheck)
196-
- **🤖 Auto-merge behaviors** (how aggressive should the bots be?)
197-
- **🏷️ PR management rules** (size labels, auto-assignment, welcome messages)
198-
199-
> **Pro tip:** Want to disable code coverage? Just add `ENABLE_CODE_COVERAGE=false` to your .env.custom to override the default in .env.base and push. No YAML archaeology required!
200-
201-
<br/>
202-
203-
| Workflow Name | Description |
204-
|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
205-
| [auto-merge-on-approval.yml](.github/workflows/auto-merge-on-approval.yml) | Automatically merges PRs after approval and all required checks, following strict rules. |
206-
| [codeql-analysis.yml](.github/workflows/codeql-analysis.yml) | Analyzes code for security vulnerabilities using [GitHub CodeQL](https://codeql.github.com/). |
207-
| [dependabot-auto-merge.yml](.github/workflows/dependabot-auto-merge.yml) | Automatically merges [Dependabot](https://github.com/dependabot) PRs that meet all requirements. |
208-
| [fortress.yml](.github/workflows/fortress.yml) | Runs the GoFortress security and testing workflow, including linting, testing, releasing, and vulnerability checks. |
209-
| [pull-request-management.yml](.github/workflows/pull-request-management.yml) | Labels PRs by branch prefix, assigns a default user if none is assigned, and welcomes new contributors with a comment. |
210-
| [scorecard.yml](.github/workflows/scorecard.yml) | Runs [OpenSSF](https://openssf.org/) Scorecard to assess supply chain security. |
211-
| [stale.yml](.github/workflows/stale-check.yml) | Warns about (and optionally closes) inactive issues and PRs on a schedule or manual trigger. |
212-
| [sync-labels.yml](.github/workflows/sync-labels.yml) | Keeps GitHub labels in sync with the declarative manifest at [`.github/labels.yml`](./.github/labels.yml). |
184+
**[View all workflows and the control center →](.github/docs/workflows.md)**
213185

214186
</details>
215187

0 commit comments

Comments
 (0)