Skip to content

Commit 4256280

Browse files
committed
docs(README): update repository features section for clarity
1 parent e37d839 commit 4256280

File tree

1 file changed

+8
-54
lines changed

1 file changed

+8
-54
lines changed

README.md

Lines changed: 8 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -142,33 +142,12 @@ magex help
142142
</details>
143143

144144
<details>
145-
<summary><strong><code>Repository Features</code></strong></summary>
145+
<summary><strong>Repository Features</strong></summary>
146146
<br/>
147147

148-
* **Continuous Integration on Autopilot** with [GitHub Actions](https://github.com/features/actions) – every push is built, tested, and reported in minutes.
149-
* **Pull‑Request Flow That Merges Itself** thanks to [auto‑merge](.github/workflows/auto-merge-on-approval.yml) and hands‑free [Dependabot auto‑merge](.github/workflows/dependabot-auto-merge.yml).
150-
* **One‑Command Builds** powered by battle‑tested [MAGE-X](https://github.com/mrz1836/mage-x) targets for linting, testing, releases, and more.
151-
* **First‑Class Dependency Management** using native [Go Modules](https://github.com/golang/go/wiki/Modules).
152-
* **Uniform Code Style** via [gofumpt](https://github.com/mvdan/gofumpt) plus zero‑noise linting with [golangci‑lint](https://github.com/golangci/golangci-lint).
153-
* **Confidence‑Boosting Tests** with [testify](https://github.com/stretchr/testify), the Go [race detector](https://blog.golang.org/race-detector), crystal‑clear [HTML coverage](https://blog.golang.org/cover) snapshots, and automatic uploads to [Codecov](https://codecov.io/).
154-
* **Hands‑Free Releases** delivered by [GoReleaser](https://github.com/goreleaser/goreleaser) whenever you create a [new Tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).
155-
* **Relentless Dependency & Vulnerability Scans** via [Dependabot](https://dependabot.com), [Nancy](https://github.com/sonatype-nexus-community/nancy) and [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck).
156-
* **Security Posture by Default** with [CodeQL](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning), [OpenSSF Scorecard](https://openssf.org) and secret‑leak detection via [gitleaks](https://github.com/gitleaks/gitleaks).
157-
* **Automatic Syndication** to [pkg.go.dev](https://pkg.go.dev/) on every release for instant godoc visibility.
158-
* **Polished Community Experience** using rich templates for [Issues & PRs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository).
159-
* **All the Right Meta Files** (`LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SUPPORT.md`, `SECURITY.md`) pre‑filled and ready.
160-
* **Code Ownership** clarified through a [CODEOWNERS](.github/CODEOWNERS) file, keeping reviews fast and focused.
161-
* **Zero‑Noise Dev Environments** with tuned editor settings (`.editorconfig`) plus curated *ignore* files for [VS Code](.editorconfig), [Docker](.dockerignore), and [Git](.gitignore).
162-
* **Label Sync Magic**: your repo labels stay in lock‑step with [.github/labels.yml](.github/labels.yml).
163-
* **Friendly First PR Workflow** – newcomers get a warm welcome thanks to a dedicated [workflow](.github/workflows/pull-request-management.yml).
164-
* **Standards‑Compliant Docs** adhering to the [standard‑readme](https://github.com/RichardLitt/standard-readme/blob/master/spec.md) spec.
165-
* **Instant Cloud Workspaces** via [Gitpod](https://gitpod.io/) – spin up a fully configured dev environment with automatic linting and tests.
166-
* **Out‑of‑the‑Box VS Code Happiness** with a preconfigured [Go](https://code.visualstudio.com/docs/languages/go) workspace and [`.vscode`](.vscode) folder with all the right settings.
167-
* **Optional Release Broadcasts** to your community via [Slack](https://slack.com), [Discord](https://discord.com), or [Twitter](https://twitter.com) – plug in your webhook.
168-
* **AI Playbook** – machine‑readable guidelines in [tech conventions](.github/tech-conventions/ai-compliance.md).
169-
* **Go-Pre-commit System** - [High-performance Go-native pre-commit hooks](https://github.com/mrz1836/go-pre-commit) with 17x faster execution—run the same formatting, linting, and tests before every commit, just like CI.
170-
* **Zero Python Dependencies** - Pure Go implementation with environment-based configuration via [.env.base](.github/.env.base).
171-
* **DevContainers for Instant Onboarding** – Launch a ready-to-code environment in seconds with [VS Code DevContainers](https://containers.dev/) and the included [.devcontainer.json](.devcontainer.json) config.
148+
This repository includes 25+ built-in features covering CI/CD, security, code quality, developer experience, and community tooling.
149+
150+
**[View the full Repository Features list →](.github/docs/repository-features.md)**
172151

173152
</details>
174153

@@ -206,42 +185,17 @@ go install github.com/mrz1836/go-pre-commit/cmd/go-pre-commit@latest
206185
go-pre-commit install
207186
```
208187

209-
The system is configured via [.env.base](.github/.env.base) and can be customized using also using [.env.custom](.github/.env.custom) and provides 17x faster execution than traditional Python-based pre-commit hooks. See the [complete documentation](http://github.com/mrz1836/go-pre-commit) for details.
188+
The system is configured via [modular environment files](.github/env/README.md) and provides 17x faster execution than traditional Python-based pre-commit hooks. See the [complete documentation](http://github.com/mrz1836/go-pre-commit) for details.
210189

211190
</details>
212191

213192
<details>
214-
<summary><strong><code>GitHub Workflows</code></strong></summary>
193+
<summary><strong>GitHub Workflows</strong></summary>
215194
<br/>
216195

217-
### 🎛️ The Workflow Control Center
218-
219-
All GitHub Actions workflows in this repository are powered by a single configuration files – your one-stop shop for tweaking CI/CD behavior without touching a single YAML file! 🎯
220-
221-
**Configuration Files:**
222-
- **[.env.base](.github/.env.base)** – Default configuration that works for most Go projects
223-
- **[.env.custom](.github/.env.custom)** – Optional project-specific overrides
224-
225-
This magical file controls everything from:
226-
- **⚙️ Go version matrix** (test on multiple versions or just one)
227-
- **🏃 Runner selection** (Ubuntu or macOS, your wallet decides)
228-
- **🔬 Feature toggles** (coverage, fuzzing, linting, race detection, benchmarks)
229-
- **🛡️ Security tool versions** (gitleaks, nancy, govulncheck)
230-
- **🤖 Auto-merge behaviors** (how aggressive should the bots be?)
231-
- **🏷️ PR management rules** (size labels, auto-assignment, welcome messages)
232-
233-
<br/>
196+
All workflows are driven by modular configuration in [`.github/env/`](.github/env/README.md) — no YAML editing required.
234197

235-
| Workflow Name | Description |
236-
|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
237-
| [auto-merge-on-approval.yml](.github/workflows/auto-merge-on-approval.yml) | Automatically merges PRs after approval and all required checks, following strict rules. |
238-
| [codeql-analysis.yml](.github/workflows/codeql-analysis.yml) | Analyzes code for security vulnerabilities using [GitHub CodeQL](https://codeql.github.com/). |
239-
| [dependabot-auto-merge.yml](.github/workflows/dependabot-auto-merge.yml) | Automatically merges [Dependabot](https://github.com/dependabot) PRs that meet all requirements. |
240-
| [fortress.yml](.github/workflows/fortress.yml) | Runs the GoFortress security and testing workflow, including linting, testing, releasing, and vulnerability checks. |
241-
| [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. |
242-
| [scorecard.yml](.github/workflows/scorecard.yml) | Runs [OpenSSF](https://openssf.org/) Scorecard to assess supply chain security. |
243-
| [stale.yml](.github/workflows/stale-check.yml) | Warns about (and optionally closes) inactive issues and PRs on a schedule or manual trigger. |
244-
| [sync-labels.yml](.github/workflows/sync-labels.yml) | Keeps GitHub labels in sync with the declarative manifest at [`.github/labels.yml`](./.github/labels.yml). |
198+
**[View all workflows and the control center →](.github/docs/workflows.md)**
245199

246200
</details>
247201

0 commit comments

Comments
 (0)