Skip to content

Commit 3db9c1a

Browse files
committed
fix: make to magex
1 parent 9a45bd1 commit 3db9c1a

1 file changed

Lines changed: 19 additions & 74 deletions

File tree

README.md

Lines changed: 19 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
<a href=".github/AGENTS.md">
5454
<img src="https://img.shields.io/badge/AGENTS.md-found-40b814?style=flat&logo=openai" alt="AGENTS.md rules">
5555
</a><br/>
56-
<a href="Makefile">
57-
<img src="https://img.shields.io/badge/Makefile-supported-brightgreen?style=flat&logo=probot&logoColor=white" alt="Makefile Supported">
56+
<a href="https://github.com/mrz1836/mage-x">
57+
<img src="https://img.shields.io/badge/Mage-supported-brightgreen?style=flat&logo=go&logoColor=white" alt="MAGE-X Supported">
5858
</a><br/>
5959
<a href=".github/dependabot.yml">
6060
<img src="https://img.shields.io/badge/dependencies-automatic-blue?logo=dependabot&style=flat" alt="Dependabot">
@@ -191,83 +191,26 @@ brew install goreleaser
191191

192192
The release process is defined in the [.goreleaser.yml](.goreleaser.yml) configuration file.
193193

194-
To generate a snapshot (non-versioned) release for testing purposes, run:
195-
196-
```bash
197-
make release-snap
198-
```
199-
200194
Then create and push a new Git tag using:
201195

202196
```bash
203-
make tag version=x.y.z
197+
magex version:bump bump=patch push
204198
```
205199

206200
This process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.
207201

208202
</details>
209203

210204
<details>
211-
<summary><strong><code>Makefile Commands</code></strong></summary>
205+
<summary><strong><code>Build Commands</code></strong></summary>
212206
<br/>
213207

214-
View all `makefile` commands
208+
View all build commands
215209

216210
```bash script
217-
make help
211+
magex help
218212
```
219213

220-
List of all current commands:
221-
222-
<!-- make-help-start -->
223-
```text
224-
bench ## Run all benchmarks in the Go application
225-
build-go ## Build the Go application (locally)
226-
clean-mods ## Remove all the Go mod cache
227-
coverage ## Show test coverage
228-
diff ## Show git diff and fail if uncommitted changes exist
229-
fumpt ## Run fumpt to format Go code
230-
generate ## Run go generate in the base of the repo
231-
godocs ## Trigger GoDocs tag sync
232-
govulncheck-install ## Install govulncheck (pass VERSION= to override)
233-
govulncheck ## Scan for vulnerabilities
234-
help ## Display this help message
235-
install-go ## Install using go install with specific version
236-
install-releaser ## Install GoReleaser
237-
install-stdlib ## Install the Go standard library for the host platform
238-
install-template ## Kick-start a fresh copy of go-template (run once!)
239-
install ## Install the application binary
240-
lint-version ## Show the golangci-lint version
241-
lint ## Run the golangci-lint application (install if not found)
242-
loc ## Total lines of code table
243-
mod-download ## Download Go module dependencies
244-
mod-tidy ## Clean up go.mod and go.sum
245-
pre-build ## Pre-build all packages to warm cache
246-
release-snap ## Build snapshot binaries
247-
release-test ## Run release dry-run (no publish)
248-
release ## Run production release (requires github_token)
249-
tag-remove ## Remove local and remote tag (use version=X.Y.Z)
250-
tag-update ## Force-update tag to current commit (use version=X.Y.Z)
251-
tag ## Create and push a new tag (use version=X.Y.Z)
252-
test-ci-no-race ## CI test suite without race detector
253-
test-ci ## CI test runs tests with race detection and coverage (no lint - handled separately)
254-
test-cover-race ## Runs unit tests with race detector and outputs coverage
255-
test-cover ## Unit tests with coverage (no race)
256-
test-fuzz ## Run fuzz tests only (no unit tests)
257-
test-no-lint ## Run only tests (no lint)
258-
test-parallel ## Run tests in parallel (faster for large repos)
259-
test-race ## Unit tests with race detector (no coverage)
260-
test-short ## Run tests excluding integration tests (no lint)
261-
test ## Default testing uses lint + unit tests (fast)
262-
uninstall ## Uninstall the Go binary
263-
update-linter ## Upgrade golangci-lint (macOS only)
264-
update-releaser ## Reinstall GoReleaser
265-
update ## Update dependencies
266-
vet-parallel ## Run go vet in parallel (faster for large repos)
267-
vet ## Run go vet only on your module packages
268-
```
269-
<!-- make-help-end -->
270-
271214
</details>
272215

273216
<details>
@@ -277,17 +220,21 @@ vet ## Run go vet only on your module packages
277220

278221
### 🎛️ The Workflow Control Center
279222

280-
All GitHub Actions workflows in this repository are powered by a single configuration file: [**.env.shared**](.github/.env.shared) – your one-stop shop for tweaking CI/CD behavior without touching a single YAML file! 🎯
223+
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! 🎯
224+
225+
**Configuration Files:**
226+
- **[.env.base](.github/.env.base)** – Default configuration that works for most Go projects
227+
- **[.env.custom](.github/.env.custom)** – Optional project-specific overrides
281228

282229
This magical file controls everything from:
283230
- **🚀 Go version matrix** (test on multiple versions or just one)
284231
- **🏃 Runner selection** (Ubuntu or macOS, your wallet decides)
285-
- **🔬 Feature toggles** (coverage, fuzzing, linting, race detection)
232+
- **🔬 Feature toggles** (coverage, fuzzing, linting, race detection, benchmarks)
286233
- **🛡️ Security tool versions** (gitleaks, nancy, govulncheck)
287234
- **🤖 Auto-merge behaviors** (how aggressive should the bots be?)
288235
- **🏷️ PR management rules** (size labels, auto-assignment, welcome messages)
289236

290-
> **Pro tip:** Want to disable code coverage? Just flip `ENABLE_CODE_COVERAGE=false` in [.env.shared](.github/.env.shared) and push. No YAML archaeology required!
237+
> **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!
291238
292239
<br/>
293240

@@ -301,8 +248,6 @@ This magical file controls everything from:
301248
| [scorecard.yml](.github/workflows/scorecard.yml) | Runs [OpenSSF](https://openssf.org/) Scorecard to assess supply chain security. |
302249
| [stale.yml](.github/workflows/stale-check.yml) | Warns about (and optionally closes) inactive issues and PRs on a schedule or manual trigger. |
303250
| [sync-labels.yml](.github/workflows/sync-labels.yml) | Keeps GitHub labels in sync with the declarative manifest at [`.github/labels.yml`](./.github/labels.yml). |
304-
| [update-python-dependencies.yml](.github/workflows/update-python-dependencies.yml) | Updates Python dependencies for pre-commit hooks in the repository. |
305-
| [update-pre-commit-hooks.yml](.github/workflows/update-pre-commit-hooks.yml) | Automatically update versions for [pre-commit](https://pre-commit.com/) hooks |
306251

307252
</details>
308253

@@ -313,28 +258,28 @@ This magical file controls everything from:
313258
To update all dependencies (Go modules, linters, and related tools), run:
314259

315260
```bash
316-
make update
261+
magex deps:update
317262
```
318263

319-
This command ensures all dependencies are brought up to date in a single step, including Go modules and any tools managed by the Makefile. It is the recommended way to keep your development environment and CI in sync with the latest versions.
264+
This command ensures all dependencies are brought up to date in a single step, including Go modules and any managed tools. It is the recommended way to keep your development environment and CI in sync with the latest versions.
320265

321266
</details>
322267

323268
<br/>
324269

325270
## 🧪 Examples & Tests
326271

327-
All unit tests and [examples](examples) run via [GitHub Actions](https://github.com/mrz1836/go-template/actions) and use [Go version 1.24.x](https://go.dev/doc/go1.24). View the [configuration file](.github/workflows/fortress.yml).
272+
All unit tests and fuzz tests run via [GitHub Actions](https://github.com/mrz1836/go-pre-commit/actions) and use [Go version 1.18.x](https://go.dev/doc/go1.18). View the [configuration file](.github/workflows/fortress.yml).
328273

329274
Run all tests (fast):
330275

331276
```bash script
332-
make test
277+
magex test
333278
```
334279

335280
Run all tests with race detector (slower):
336281
```bash script
337-
make test-race
282+
magex test:race
338283
```
339284

340285
<br/>
@@ -344,7 +289,7 @@ make test-race
344289
Run the Go [benchmarks](sanitize_benchmark_test.go):
345290

346291
```bash script
347-
make bench
292+
magex bench
348293
```
349294

350295
<br/>

0 commit comments

Comments
 (0)