Skip to content

docs: align dev docs and release notes with current tooling #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oleg-flamingocx merged 2 commits into from
Jul 13, 2026
+18 −15
Merged

docs: align dev docs and release notes with current tooling #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4033f89
docs: align dev docs and release notes with current tooling
oleg-flamingocx Jul 13, 2026
f6971d0
docs: describe "Other Changes" as the catch-all, not just unlabeled
oleg-flamingocx Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
# Notes are built per merged PR and categorized by the PR's LABELS, which is
# robust to this repo's squash-merge + free-form PR titles (commit-title regexes
# would miss most of them). A PR lands in the FIRST category whose label it
# carries; anything unlabeled falls through to "Other Changes".
# carries; anything not matched by an earlier category (unlabeled, or labeled
# but uncategorized) falls through to the "Other Changes" catch-all.
changelog:
exclude:
labels:
Expand Down
18 changes: 8 additions & 10 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Release Notes Template
# Release Notes

This file is a template for release notes. When running the GitHub Actions workflow, this file will be replaced with auto-generated content.
Generated by GitHub, not from this file (nothing in the release pipeline reads
it). GoReleaser uses `changelog.use: github-native`, so notes come from GitHub's
API, categorized by PR **label** via [`.github/release.yml`](.github/release.yml):
Features (`enhancement`), Bug Fixes (`bug`), Documentation (`documentation`),
Other (anything not matched above), excluded (`automated`/bots/etc). Label your PR to influence
them — title wording is ignored.

## CLI Binaries
Build binaries locally without publishing:

Download the appropriate archive for your platform from the release assets.

## For Local Testing

When running GoReleaser locally, use:
```bash
goreleaser release --clean --skip=validate --skip=publish --snapshot
```

The `--snapshot` flag will skip release creation and just build the binaries.
12 changes: 8 additions & 4 deletions docs/development/setup/local-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Unit tests are colocated as `*_test.go` next to the code they cover.
# Build for your current platform (produces openframe-<os>-<arch>)
make build

# Build for all platforms
# Cross-compile all six release platforms (matches .goreleaser.yml)
make build-all

# Or build directly
Expand Down Expand Up @@ -84,18 +84,22 @@ k3d cluster delete openframe-test
## Lint and Format

```bash
make lint # golangci-lint run ./...
gofmt -w .
goimports -w .
make fmt # gofmt -w over the tree
make vet # go vet ./...
make lint # golangci-lint run ./...
make tidy # fail if `go mod tidy` would change go.mod/go.sum
```

These mirror the CI gates — run them before pushing.

## Development Workflow

```bash
# Sync with upstream
git fetch upstream && git checkout main && git merge upstream/main

# Create a branch, make changes, then before committing:
make fmt vet tidy
make test
make lint

Expand Down