Skip to content

Commit cd4320f

Browse files
committed
docs(README): update GitHub workflows section for clarity
1 parent a12d421 commit cd4320f

1 file changed

Lines changed: 3 additions & 31 deletions

File tree

README.md

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

240240
<details>
241-
<summary><strong><code>GitHub Workflows</code></strong></summary>
241+
<summary><strong>GitHub Workflows</strong></summary>
242242
<br/>
243243

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

245-
### 🎛️ The Workflow Control Center
246-
247-
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! 🎯
248-
249-
**Configuration Files:**
250-
- **[.env.base](.github/.env.base)** – Default configuration that works for most Go projects
251-
- **[.env.custom](.github/.env.custom)** – Optional project-specific overrides
252-
253-
This magical file controls everything from:
254-
- **🚀 Go version matrix** (test on multiple versions or just one)
255-
- **🏃 Runner selection** (Ubuntu or macOS, your wallet decides)
256-
- **🔬 Feature toggles** (coverage, fuzzing, linting, race detection, benchmarks)
257-
- **🛡️ Security tool versions** (gitleaks, nancy, govulncheck)
258-
- **🤖 Auto-merge behaviors** (how aggressive should the bots be?)
259-
- **🏷️ PR management rules** (size labels, auto-assignment, welcome messages)
260-
261-
> **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!
262-
263-
<br/>
264-
265-
| Workflow Name | Description |
266-
|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
267-
| [auto-merge-on-approval.yml](.github/workflows/auto-merge-on-approval.yml) | Automatically merges PRs after approval and all required checks, following strict rules. |
268-
| [codeql-analysis.yml](.github/workflows/codeql-analysis.yml) | Analyzes code for security vulnerabilities using [GitHub CodeQL](https://codeql.github.com/). |
269-
| [dependabot-auto-merge.yml](.github/workflows/dependabot-auto-merge.yml) | Automatically merges [Dependabot](https://github.com/dependabot) PRs that meet all requirements. |
270-
| [fortress.yml](.github/workflows/fortress.yml) | Runs the GoFortress security and testing workflow, including linting, testing, releasing, and vulnerability checks. |
271-
| [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. |
272-
| [scorecard.yml](.github/workflows/scorecard.yml) | Runs [OpenSSF](https://openssf.org/) Scorecard to assess supply chain security. |
273-
| [stale.yml](.github/workflows/stale-check.yml) | Warns about (and optionally closes) inactive issues and PRs on a schedule or manual trigger. |
274-
| [sync-labels.yml](.github/workflows/sync-labels.yml) | Keeps GitHub labels in sync with the declarative manifest at [`.github/labels.yml`](./.github/labels.yml). |
246+
**[View all workflows and the control center →](.github/docs/workflows.md)**
275247

276248
</details>
277249

0 commit comments

Comments
 (0)