chore: automate release process with release-please#269
Open
fan-zhang-sv wants to merge 5 commits intomasterfrom
Open
chore: automate release process with release-please#269fan-zhang-sv wants to merge 5 commits intomasterfrom
fan-zhang-sv wants to merge 5 commits intomasterfrom
Conversation
Replace the manual 3-step release process (version bump PR, trigger workflow, write release notes) with release-please automation that reduces it to a single step: merge the auto-generated Release PR. Made-with: Cursor
Collaborator
✅ Heimdall Review Status
|
stephancill
previously approved these changes
Apr 8, 2026
stephancill
reviewed
Apr 8, 2026
Comment on lines
+97
to
+118
| We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for our commit messages. This helps us generate changelogs and follow a standard format. | ||
|
|
||
| PR titles are validated against this format in CI. A valid PR title looks like: | ||
|
|
||
| - `feat: add wallet connection support` | ||
| - `fix: resolve session timeout issue` | ||
| - `feat!: redesign payment API` (breaking change) | ||
| - `chore: update dependencies` | ||
|
|
||
| ## Releasing | ||
|
|
||
| Releases are automated using [release-please](https://github.com/googleapis/release-please). The process is driven by [Conventional Commits](#git-commit-messages). | ||
|
|
||
| ### How it works | ||
|
|
||
| 1. When PRs with `feat:`, `fix:`, or breaking change commits are merged to `master`, release-please automatically opens (or updates) a **Release PR** for each affected package. | ||
| 2. The Release PR contains the version bump in `package.json` and an updated `CHANGELOG.md`. | ||
| 3. The version is determined automatically from commit types: | ||
| - `fix:` -> patch (e.g., 2.5.3 -> 2.5.4) | ||
| - `feat:` -> minor (e.g., 2.5.3 -> 2.6.0) | ||
| - `feat!:` or `BREAKING CHANGE:` footer -> major (e.g., 2.5.3 -> 3.0.0) | ||
| 4. When you're ready to release, **merge the Release PR**. This triggers npm publish, git tag creation, and a GitHub Release automatically. |
Collaborator
There was a problem hiding this comment.
can we add this to an AGENTS.md in repo root pls
- Add agent guideline files for Cursor and Claude Code with repo-specific conventions (Yarn 4, Preact, path aliases, generated files, etc.) - Align account-ui publish job to use OIDC auth instead of NPM_TOKEN, matching the account-sdk publish pattern Made-with: Cursor
Single source of truth for agent guidelines. Made-with: Cursor
Match the pattern in release-please.yml: use OIDC via id-token instead of explicit NPM_TOKEN, and add npm update step. Made-with: Cursor
Consistent with all other publish workflows. Made-with: Cursor
cb-jake
reviewed
Apr 10, 2026
Collaborator
cb-jake
left a comment
cb-jake
left a comment
There was a problem hiding this comment.
Curious why we dont need an NPM token to publish anymore. Unless I missed something in the release-please workflow
Comment on lines
-41
to
-43
| - name: Set deployment token | ||
| run: npm config set '//registry.npmjs.org/:_authToken' "${{ secrets.NPM_TOKEN }}" | ||
|
|
Collaborator
There was a problem hiding this comment.
I'm curious why we don't need this anymore?
Collaborator
Author
There was a problem hiding this comment.
the secret is already in the environment set above at line 14 environment: publish.
i just found out the old release-account didn't have to set the npm token for release and it still works, so i removed this extra step in all workflow
fan-zhang-sv
commented
Apr 10, 2026
Comment on lines
49
to
51
| run: | | ||
| cd packages/account-sdk | ||
| npm publish --tag latest --access public |
Collaborator
Author
There was a problem hiding this comment.
cc: @cb-heimdall on the old release account
stephancill
approved these changes
Apr 14, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
Replace the current manual 3-step release process with release-please automation, reducing it to a single step: merge the auto-generated Release PR.
Before (3 manual steps)
package.jsonAfter (1 step)
Everything else — version bump, changelog, npm publish, git tag, GitHub Release — happens automatically.
Changes
New files
release-please-config.json— Configures release-please for@base-org/accountand@base-org/account-uias separate packages with path-scoped changelogs (include-pathsensures commits only appear in the relevant package's changelog).release-please-manifest.json— Seeds current versions (account 2.5.3, account-ui 1.0.1) so release-please knows where to start.github/workflows/release-please.yml— Main automation workflow:master, release-please creates/updates a Release PR per package with version bump +CHANGELOG.mdfix:→ patch,feat:→ minor,feat!:/BREAKING CHANGE→ majorpublish-accountandpublish-account-ui) with the same build/publish steps as the existing workflows.github/workflows/pr-title.yml— Enforces Conventional Commits format on PR titles (required since squash merges use the PR title as the commit message, and release-please depends on this)Modified files
.github/workflows/release-account-canary.yml— Version input is now optional. When left empty, it auto-detects the next version from the pending release-please PR (viagh pr list --label "autorelease: pending"). Manual override is still supported.CONTRIBUTING.md— Added a "Releasing" section documenting the stable and canary release process, and added PR title format examples under Git Commit MessagesDeprecated files (kept as fallback)
release-account.yml→release-account-manual.yml— Renamed with[DEPRECATED]prefix. Still functional as a fallback if release-please fails. To be removed after the first successful automated release.release-ui.yml→release-ui-manual.yml— Same treatment.How it works
@base-org/accountand@base-org/account-uihave separate Release PRs and can be released independentlyworkflow_dispatch, but no longer require version inputpackage.jsonon master is always correct after merging the Release PR (no follow-up PR needed)Post-merge action required
Add
PR Title / lintas a required status check in the repo's branch protection settings formasterto enforce Conventional Commits as a hard gate.Test plan
release-account-manual.ymlandrelease-ui-manual.ymlMade with Cursor