openclaw/goplaces
openclaw/goplaces
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

docs(release): sync docs for 0.3.0 and github release flow

Browse Source
This commit is contained in:
Peter Steinberger 2026-02-14 06:03:13 +01:00
parent 46fa4a1323
commit 58d9d817d3
3 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -20,7 +20,7 @@ Modern Go client + CLI for the Google Places API (New). Fast for humans, tidy fo
## Install / Run
Latest release: v0.2.1 (2026-01-23).
Latest release: v0.3.0 (2026-02-14).
- Homebrew: `brew install steipete/tap/goplaces`
- Go: `go install github.com/steipete/goplaces/cmd/goplaces@latest`

8
docs/releasing-homebrew.md
View File

@ -1,6 +1,6 @@
# goplaces Homebrew Release Playbook
Manual/local tap update (no GitHub token). This doc mirrors camsnap style.
Manual/local tap update from GitHub release assets.
## Prereqs
@ -10,8 +10,8 @@ Manual/local tap update (no GitHub token). This doc mirrors camsnap style.
## Release
1) Tag + push: `git tag vX.Y.Z && git push origin vX.Y.Z`
2) GitHub Actions builds binaries (workflow artifacts only).
3) Host artifacts somewhere public (e.g., attach to a manual GitHub release).
2) GitHub Actions builds binaries (workflow artifacts).
3) Create/publish GitHub release `vX.Y.Z` and upload archives.
4) Update the tap locally:
- In `../homebrew-tap/Formula/goplaces.rb`, set `version`, `url`, `sha256`.
- Commit + push in `../homebrew-tap`.
@ -24,4 +24,4 @@ brew update && brew install steipete/tap/goplaces
## Troubleshooting
- CI does not publish releases or Homebrew.
- CI does not publish GitHub releases or Homebrew automatically.

16
docs/releasing.md
View File

@ -7,9 +7,9 @@ Quick, repeatable release checklist. Mirrors gifgrep cadence.
- Update `CHANGELOG.md` for the new version.
- Run gate: `./scripts/check-coverage.sh` + `golangci-lint run ./...`.
- Ensure `main` is clean and pushed.
- Ensure `HOMEBREW_TAP_GITHUB_TOKEN` secret is set (pushes formula to `steipete/homebrew-tap`).
- Ensure `gh` is authenticated for `steipete/goplaces` + `steipete/homebrew-tap`.
## Tag + Release
## Tag + Build
```bash
git tag vX.Y.Z
@ -17,9 +17,17 @@ git push origin vX.Y.Z
```
GitHub Actions runs GoReleaser build on tag push (`.github/workflows/release.yml`).
Artifacts are stored on the workflow run (no GitHub release publish).
Artifacts are stored on the workflow run.
Homebrew (local tap update): see `docs/releasing-homebrew.md`.
## Publish GitHub Release
Create a release from the tag and upload built archives (`goplaces_<version>_<os>_<arch>.tar.gz|zip`):
```bash
gh release create vX.Y.Z ./dist-archives/* --repo steipete/goplaces --title vX.Y.Z --notes-file /tmp/release-notes.md
```
Homebrew update: see `docs/releasing-homebrew.md`.
## Notes