[fei6062.releaseprotections] Update prepublish checks to add SNAPSHOT_RELEASE support #2412
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: cdd7188 The changes in this PR will be included in the next version bump. This PR includes changesets to release 31 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
GeraldRequired Reviewers
Don't want to be involved in this pull request? Comment |
|
Size Change: 0 B Total Size: 96.3 kB ℹ️ View Unchanged
|
A new build was pushed to Chromatic! 🚀https://5e1bf4b385e3fb0020b7073c-lvssletngb.chromatic.com/ Chromatic results:
|
npm Snapshot: Published🎉 Good news!! We've packaged up the latest commit from this PR (275c143) and published all packages with changesets to npm. You can install the packages in webapp by running: ./services/static/dev/tools/deploy_wonder_blocks.js --tag="PR2412"Packages can also be installed manually by running: yarn add @khanacademy/wonder-blocks-<package-name>@PR2412 |
|
The changeset error is too sensitive. These changes don't need releasing. |
There was a problem hiding this comment.
note: This isn't a big a change as it's making out.
utils/publish/pre-publish-utils.ts
Outdated
There was a problem hiding this comment.
note: This isn't as big a change as it's making out.
Comment on lines
+22
to
+23
| // Get the root folder; use the LICENSE file as our root anchor. | ||
| const rootDir = ancesdir(__dirname, "LICENSE"); |
There was a problem hiding this comment.
note: Other than making it so all checks are run before exiting (this is copied from Perseus and tested), this is the biggest change that isn't in Perseus - using ancesdir to locate the root directory rather than hard-coding it. This way it'll work if the file gets moved around.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2412 +/- ##
============================
============================
Continue to review full report in Codecov by Sentry.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
This brings over the latest updates from Perseus, and edits them for Wonder Blocks. The changes are:
prepublishOnlyscript in each package that blocks publishing non-snapshot packages when publishing snapshotsSNAPSHOT_RELEASEenv varpre-publish-check-ci.jsandpre-publish-utils.jsfiles to TypeScriptpre-publish-check-ci.tsexecutablepre-publish-check-ci.tsto ensure that each public package has theprepublishOnlyscriptpre-publish-utils.tsandpre-publish-check-ci.tsto perform all checks before erroring, instead of quitting on the first failure. This is a quality of life change to make it easier on devs having to update multiple packages to conformLong term, might be nice to have a
wonder-stuff-clior something that can encapsulate this stuff across our packages.This change adds initial protection against accidentally publishing release package versions under a snapshot tag. It protects both automated runs and runs done by a user locally.
The next PR will add workflow changes to block the snapshot publish jobs from running when there is a release workflow in progress. This adds an additional layer of protection and also provides a nicer dev experience by adding a useful PR comment on why it failed.
Methodology:
I diffed the Perseus and Wonder Blocks scripts to work out what was different, then updated things to TS. I then modified the publish script and workflows, as necessary. Finally, I used Copilot Edits in VSCode to update the package.json files with the new
prepublishOnlyscript.Issue: FEI-6062
Test plan:
This stuff is working in Perseus already. I've tested the new executable nature of the pre-publish checks, and verified the
SNAPSHOT_RELEASEbehavior for packages by runningSNAPSHOT_RELEASE=1 yarn run prepublishOnlyin a few packages.