Skip to content

Commit 7d336a1

Browse files
committed
docs(README): update GitHub workflows section for clarity
1 parent 5ffd1c8 commit 7d336a1

File tree

1 file changed

+3
-31
lines changed

1 file changed

+3
-31
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -333,40 +333,12 @@ magex help
333333
</details>
334334

335335
<details>
336-
<summary><strong><code>GitHub Workflows</code></strong></summary>
336+
<summary><strong>GitHub Workflows</strong></summary>
337337
<br/>
338338

339+
All workflows are driven by modular configuration in [`.github/env/`](.github/env/README.md) β€” no YAML editing required.
339340

340-
### πŸŽ›οΈ The Workflow Control Center
341-
342-
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! 🎯
343-
344-
**Configuration Files:**
345-
- **[.env.base](.github/.env.base)** – Default configuration that works for most Go projects
346-
- **[.env.custom](.github/.env.custom)** – Optional project-specific overrides
347-
348-
This magical file controls everything from:
349-
- **πŸš€ Go version matrix** (test on multiple versions or just one)
350-
- **πŸƒ Runner selection** (Ubuntu or macOS, your wallet decides)
351-
- **πŸ”¬ Feature toggles** (coverage, fuzzing, linting, race detection, benchmarks)
352-
- **πŸ›‘οΈ Security tool versions** (gitleaks, nancy, govulncheck)
353-
- **πŸ€– Auto-merge behaviors** (how aggressive should the bots be?)
354-
- **🏷️ PR management rules** (size labels, auto-assignment, welcome messages)
355-
356-
> **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!
357-
358-
<br/>
359-
360-
| Workflow Name | Description |
361-
|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
362-
| [auto-merge-on-approval.yml](.github/workflows/auto-merge-on-approval.yml) | Automatically merges PRs after approval and all required checks, following strict rules. |
363-
| [codeql-analysis.yml](.github/workflows/codeql-analysis.yml) | Analyzes code for security vulnerabilities using [GitHub CodeQL](https://codeql.github.com/). |
364-
| [dependabot-auto-merge.yml](.github/workflows/dependabot-auto-merge.yml) | Automatically merges [Dependabot](https://github.com/dependabot) PRs that meet all requirements. |
365-
| [fortress.yml](.github/workflows/fortress.yml) | Runs the GoFortress security and testing workflow, including linting, testing, releasing, and vulnerability checks. |
366-
| [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. |
367-
| [scorecard.yml](.github/workflows/scorecard.yml) | Runs [OpenSSF](https://openssf.org/) Scorecard to assess supply chain security. |
368-
| [stale.yml](.github/workflows/stale-check.yml) | Warns about (and optionally closes) inactive issues and PRs on a schedule or manual trigger. |
369-
| [sync-labels.yml](.github/workflows/sync-labels.yml) | Keeps GitHub labels in sync with the declarative manifest at [`.github/labels.yml`](./.github/labels.yml). |
341+
**[View all workflows and the control center β†’](.github/docs/workflows.md)**
370342

371343
</details>
372344

0 commit comments

Comments
Β (0)