Skip to content

Commit 0876698

Browse files
committed
Enhance GitHub Actions workflow documentation for building and testing Go application
1 parent 32efbe7 commit 0876698

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

.github/workflows/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ Scans the repository for secrets and sensitive information that may have been ac
2222

2323
**Tip:** Never commit real secrets; use placeholders in committed files and store actual secrets outside the repo.
2424

25+
### Build
26+
27+
Builds the Go binary and runs tests. Must succeed before merging into `main`.
28+
29+
**Triggers:**
30+
- Push to `main`
31+
- Pull requests targeting `main`
32+
33+
**What it does:**
34+
- Sets up Go using the version from `go.mod`
35+
- Runs `go build -o bin/cowardly ./cmd/cowardly`
36+
- Runs `go test ./...`
37+
38+
**Local:** Run `make build` to build, `make test` to test, or `make run` to build and run the TUI.
39+
2540
### Prettier
2641

2742
Checks that Markdown, JSON, YAML, and other supported files are formatted according to [Prettier](https://prettier.io/).

0 commit comments

Comments
 (0)