-
Notifications
You must be signed in to change notification settings - Fork 8
Release engineering: script, package managers, completions, docs #171
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.
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3a59a20
Release engineering: script, package managers, completions, docs
jeremy f8b2755
aur: add provides, conflicts, optdepends per AUR guidelines
jeremy 17443a1
Rename LICENSE.md to MIT-LICENSE, add surface compat to release-check
jeremy d1be3a0
Allow bcq-release-bot in naming check (actual GitHub App name)
jeremy 92ce046
Address PR review feedback
jeremy 4896f00
Address second round of PR review feedback
jeremy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| * @basecamp/sip | ||
| .goreleaser.yaml @basecamp/sip | ||
| .github/workflows/ @basecamp/sip | ||
| scripts/release.sh @basecamp/sip | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ## What | ||
|
|
||
| ## Why | ||
|
|
||
| ## Testing | ||
|
|
||
| - [ ] `make check` passes |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Releasing | ||
|
|
||
| ## Quick release | ||
|
|
||
| ```bash | ||
| make release VERSION=0.2.0 | ||
| ``` | ||
|
|
||
| ## Dry run | ||
|
|
||
| ```bash | ||
| make release VERSION=0.2.0 DRY_RUN=1 | ||
| ``` | ||
|
|
||
| ## What happens | ||
|
|
||
| 1. Validates semver format, main branch, clean tree, synced with remote | ||
| 2. Checks for `replace` directives in go.mod | ||
| 3. Runs `make release-check` (quality checks, vuln scan, replace-check, race-test, surface compat) | ||
| 4. Creates annotated tag `v$VERSION` and pushes to origin | ||
| 5. GitHub Actions [release workflow](.github/workflows/release.yml) runs: | ||
| - Security scan + full test suite + CLI surface compatibility check | ||
| - Collects PGO profile from benchmarks | ||
| - Generates AI changelog from commit history | ||
| - Builds binaries for all platforms (darwin, linux, windows, freebsd, openbsd × amd64/arm64) | ||
| - Signs checksums with cosign (keyless via Sigstore OIDC) | ||
| - Generates SBOM for supply chain transparency | ||
| - Updates Homebrew cask in `basecamp/homebrew-tap` | ||
| - Updates Scoop manifest in `basecamp/homebrew-tap` | ||
| - Updates AUR `basecamp-bin` package (when `AUR_KEY` is configured) | ||
|
|
||
| ## Versioning | ||
|
|
||
| Pre-1.0: minor bumps for features, patch bumps for fixes. Prerelease tags | ||
| (e.g. `0.2.0-rc.1`) are marked as prereleases automatically by GoReleaser. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - On `main` branch with clean, synced working tree | ||
| - No `replace` directives in go.mod | ||
| - `make release-check` passes (includes check, replace-check, vuln scan, race-test, surface compat) | ||
|
|
||
| ## CI secrets | ||
|
|
||
| | Secret | Purpose | | ||
| |--------|---------| | ||
| | `RELEASE_CLIENT_ID` (var) | GitHub App ID for `bcq-release-bot` | | ||
| | `RELEASE_APP_PRIVATE_KEY` | GitHub App private key | | ||
| | `AUR_KEY` | SSH private key for AUR push (optional) | | ||
|
|
||
| ## AUR setup (one-time) | ||
|
|
||
| 1. Create an account at https://aur.archlinux.org | ||
| 2. Register the `basecamp-bin` package | ||
| 3. Generate an SSH keypair: `ssh-keygen -t ed25519 -f aur_key -C "basecamp-cli AUR"` | ||
| 4. Add the public key to your AUR profile | ||
| 5. Add the private key as `AUR_KEY` in GitHub Actions secrets | ||
|
|
||
| ## Distribution channels | ||
|
|
||
| | Channel | Location | Updated by | | ||
| |---------|----------|------------| | ||
| | GitHub Releases | [basecamp/basecamp-cli](https://github.com/basecamp/basecamp-cli/releases) | GoReleaser | | ||
| | Homebrew cask | `basecamp/homebrew-tap` Casks/ | GoReleaser | | ||
| | Scoop | `basecamp/homebrew-tap` root | GoReleaser | | ||
| | AUR | `basecamp-bin` | GoReleaser | | ||
| | go install | `go install github.com/basecamp/basecamp-cli/cmd/basecamp@latest` | Go module proxy | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.