feat: add is-snap argument to publish-preview.yml workflow#254
Open
mikesposito wants to merge 2 commits into
Open
feat: add is-snap argument to publish-preview.yml workflow#254mikesposito wants to merge 2 commits into
is-snap argument to publish-preview.yml workflow#254mikesposito wants to merge 2 commits into
Conversation
Allow callers to pass arbitrary build-time environment variables to the build step via a JSON object passed as a secret. This is needed by snap consumers whose build commands require additional configuration (e.g. API URLs, RPC endpoints) to produce valid preview builds.
Member
Author
|
This workflow variation has been tested on this repository: |
wantedsystem
approved these changes
May 21, 2026
mcmire
reviewed
May 21, 2026
Comment on lines
+26
to
+30
| is-snap: | ||
| description: 'Whether the consumer is a Snap. When true, the build runs before manifests are renamed so that snap artifacts (e.g. dist/bundle.js, snap.manifest.json) capture the original package name.' | ||
| type: boolean | ||
| required: false | ||
| default: false |
Contributor
There was a problem hiding this comment.
Instead of adding a flag that's specific to a type of project, what are your thoughts on adding a flag that describes the behavior? Maybe something like:
Suggested change
| is-snap: | |
| description: 'Whether the consumer is a Snap. When true, the build runs before manifests are renamed so that snap artifacts (e.g. dist/bundle.js, snap.manifest.json) capture the original package name.' | |
| type: boolean | |
| required: false | |
| default: false | |
| rename-after-install-and-build: | |
| description: 'Governs where in the workflow that packages in the repo are renamed to use the preview build scope. If true, this step runs after the install and build steps; if false (default), it runs before. This option is mostly for Snaps so that artifacts (e.g. dist/bundle.js, snap.manifest.json) capture the original package name, not the preview build name.' | |
| type: boolean | |
| required: false | |
| default: false |
|
|
||
| ### Added | ||
|
|
||
| - Add `is-snap` input to the `publish-preview` reusable workflow |
Contributor
There was a problem hiding this comment.
Can you associate the current PR with these changelog entries? e.g.
Suggested change
| - Add `is-snap` input to the `publish-preview` reusable workflow | |
| - Add `is-snap` input to the `publish-preview` reusable workflow ([#254](https://github.com/MetaMask/github-tools/pull/254)) |
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.
The reusable publish-preview workflow renames each workspace's package.json#name from
@metamask/...to@metamask-previews/...before running the build. This works for typical libraries but breaks for Snap packages, because:When the rename happens before the build, the bundle and manifest are produced against the preview scope, the shasum is computed over the contaminated bundle, and downstream clients that verify against the published @metamask/... shasum reject the snap.
The workaround used by snap repos today (e.g. snap-tron-wallet) is to build first, then rename — but the reusable workflow had no way to express that ordering.
To fix this issue and make this workflow usable for Snaps, this PR adds a new boolean input
is-snap(default false) to.github/workflows/publish-preview.yml.Existing consumers don't need to change anything. Snap consumers add a single input:
Note
Medium Risk
Changes the
publish-previewreusable workflow’s build/install ordering and introduces a new secret-driven environment injection for builds, which could affect preview artifact contents and publishing behavior if misconfigured.Overview
Updates the reusable
publish-previewworkflow to support Snap consumers via a newis-snapinput that runs install + build before renamingpackage.jsonmanifests to the preview NPM scope.Adds optional
BUILD_ENV(JSON) secret support and passes it into the build step, allowing build-time configuration/secrets without changing the workflow call. The changelog documents both additions.Reviewed by Cursor Bugbot for commit 989eead. Bugbot is set up for automated code reviews on this repo. Configure here.