Skip to content

docs: Add release process documentation - #165

Merged
samir-gandhi merged 2 commits into
pingone-core-resourcesfrom
docs/release-process
Oct 20, 2026
Merged

samir-gandhi merged 2 commits into
pingone-core-resourcesfrom
docs/release-process

Conversation

@samir-gandhi

Copy link
Copy Markdown
Contributor

Summary

Adds CONTRIBUTING.release.md documenting the release checklist, and links it from CONTRIBUTING.md.

The repo previously had no local release-process doc. This captures:

  • The goreleaser tag-driven workflow and what it publishes (binaries, Linux packages, Homebrew cask)
  • The checklist step to tag only from a branch carrying the current .goreleaser.yaml (tagging an old branch republishes the deprecated formula)
  • The skip_upload: auto behaviour: prerelease tags publish a GitHub prerelease but skip the Homebrew cask
  • The cask's quarantine xattr post-install hook and when to remove it
  • History of the brews → homebrew_casks migration (PR release: Replace deprecated brews config with homebrew_casks #164) and its coordination with pingidentity/homebrew-tap#25, including the pending follow-up to delete the stale tap formula

Motivation: the cask migration requires ordered follow-up steps (merge tap migration PR only after first cask-publishing release, then delete the old formula). Without a local doc, those steps risk being missed in a future release.

Tests

Docs-only change; no tests. Markdown links verified against files in the repo.

Breaking changes

None.

🤖 Generated with Claude Code

samir-gandhi and others added 2 commits October 20, 2026 13:10
Documents the goreleaser release checklist, including the
homebrew_casks migration (PR #164) and the tap_migrations.json
coordination with pingidentity/homebrew-tap#25, so the cask-related
release steps are caught during future releases.

Co-Authored-By: Claude Code <noreply@anthropic.com>
Co-Authored-By: Claude Code <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Regression Test Results

Matrix Entry Status Breaking Acceptable

✅ No regressions detected

All export configurations produced compatible output.


Generated by regression workflow • View run

@samir-gandhi
samir-gandhi changed the base branch from main to pingone-core-resources October 20, 2026 20:32
@samir-gandhi
samir-gandhi merged commit 1688e31 into pingone-core-resources Oct 20, 2026
3 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant