Skip to content

Configure publishing workflow#34

Merged
lopert merged 3 commits into
mainfrom
lopert.initial-release
Nov 4, 2025
Merged

Configure publishing workflow#34
lopert merged 3 commits into
mainfrom
lopert.initial-release

Conversation

@lopert
Copy link
Copy Markdown
Collaborator

@lopert lopert commented Nov 4, 2025

Sets up the release workflow as per our docs.

This is the first step of the following flow:

  1. Merge this PR (with workflow + changesets setup) to main
    - Workflow runs but does nothing (no changesets = no action)
  2. Create a new PR with a changeset and merge to main
    - Workflow runs and creates/updates a "Version Packages" PR
    - This PR will show the version bump and changelog updates
  3. Merge the "Version Packages" PR to main
    - Workflow runs and publishes to npm.js
    - Creates git tags

@lopert lopert marked this pull request as ready for review November 4, 2025 16:44
@lopert lopert changed the title Prep for initial release Configure publishing workflow Nov 4, 2025
@lopert lopert requested review from a team, mkcny and saga-dasgupta and removed request for a team November 4, 2025 16:45
Copy link
Copy Markdown
Contributor

@saga-dasgupta saga-dasgupta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines up with the instructions on the vault page.

Comment thread package.json
"lint": "eslint src/ test/",
"lint:fix": "eslint src/ test/ --fix",
"prepublishOnly": "pnpm run build && pnpm run test && pnpm run lint"
"prepublishOnly": "pnpm run build && pnpm run test && pnpm run lint",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the README I have all commands as pnpm build, pnpm test etc, should we keep it that way here as well?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think either way is fine. In our CI.yml workflow, it uses the run variants, so I'll keep this one here with it as well for consistency.

Comment thread .github/workflows/release.yml Outdated
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also make this env variable up top for better visibility?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. I think it's worth having split out since we will want to easily find it when it comes to updating things to stay consistent with what the CLI expects.

@lopert lopert merged commit f6b2b64 into main Nov 4, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants