Add prepublish checks to block releases of non-snapshot versionsfirst one #2037

somewhatabstract · 2024-12-19T00:09:40Z

Summary:

This PR implements a simple preventative measure for the race condition described by https://khanacademy.atlassian.net/wiki/spaces/ENG/pages/3571646568/Race+condition+breaks+Perseus+release whereby an in progress release triggered via merging a changesets PR and a snapshot release triggered by a PR update can lead to a snapshot releasing an actual versioned release.

The events that cause this look something like:

Version Packages merged, updating versions in main
Someone updates their PR with a merge of main, updating its versions to the ones in main that are not yet published
The PR action to publish a snapshot runs, but the main release isn't done yet so the new releases aren't present in NPM
The snapshot release tries to publish those packages before the main release has tried

This change should prevent that last step; failing the snapshot release.

We could look at trying other ways to prevent this, such as making the `release.yml`` workflow responsible for snapshot releases too and limit concurrency. However, even that won't fully prevent this since the merge of the "Version Packages" PR does not guarantee the run order of the release workflow and the snapshot workflow.

So, this helps prevent the incorrect publish occurring without impacting the official release process - only PR snapshot releases get affected in the cases where this might occur (which seem to be rare, for now).

This update also modifies our pre-publish checks to look for all errors before quitting, instead of quitting on the first one. This is a quality of life change for devs that modify this script and need to check all packages are passing without having to run, then fix, then run, then fix, repeatedly.

Issue: XXX-XXXX

Test plan:

I ran SNAPSHOT_RELEASE=1 npm publish --dry-run on a package that had a non-snapshot release version, and it failed as expected. I also ran it on a package that had the correct 0.0.0-PR... format, and it succeeded. I also ran a npm publish --dry-run on a package without the SNAPSHOT_RELEASE env var, and it succeeded.

…ng on first one

github-actions · 2024-12-19T00:13:26Z

npm Snapshot: Published

Good news!! We've packaged up the latest commit from this PR (165f468) and published it to npm. You
can install it using the tag PR2037.

Example:

yarn add @khanacademy/perseus@PR2037

If you are working in Khan Academy's webapp, you can run:

./dev/tools/bump_perseus_version.sh -t PR2037

github-actions · 2024-12-19T00:13:34Z

Size Change: 0 B

Total Size: 1.27 MB

ℹ️ View Unchanged

Filename	Size
`packages/kas/dist/es/index.js`	39 kB
`packages/keypad-context/dist/es/index.js`	760 B
`packages/kmath/dist/es/index.js`	4.26 kB
`packages/math-input/dist/es/index.js`	78 kB
`packages/math-input/dist/es/strings.js`	1.79 kB
`packages/perseus-core/dist/es/index.js`	1.48 kB
`packages/perseus-editor/dist/es/index.js`	688 kB
`packages/perseus-linter/dist/es/index.js`	22.2 kB
`packages/perseus/dist/es/index.js`	417 kB
`packages/perseus/dist/es/strings.js`	4.93 kB
`packages/pure-markdown/dist/es/index.js`	3.67 kB
`packages/simple-markdown/dist/es/index.js`	12.5 kB

_{compressed-size-action}

…eset per package and I don't know how to do an infrastructure update like this and pass that check

jeremywiebe · 2024-12-19T00:16:56Z

utils/internal/pre-publish-utils.ts

+    // check that we are running our pre-publish check for this package
+    if (
+        !scripts.prepublishOnly ||
+        !scripts.prepublishOnly.includes("utils/package-pre-publish-check.sh")
+    ) {
+        console.error(
+            `ERROR: ${name} must have a "prepublishOnly" script that runs "utils/package-pre-publish-check.sh".`,
+        );
+        returnCode = false;
+    }


Yay. Thanks for adding this check here too!

jeremywiebe · 2024-12-19T00:23:24Z

packages/perseus-core/package.json

@@ -30,4 +31,4 @@
    },
    "peerDependencies": {},
    "keywords": []
-}
+}


OCD-level 10 comment: looks like all the package.json lost their newline at end of file. I'm not sure if that matters, but Github flags it so... 🤷‍♂️

It doesn't make a difference. I just saved like usual - no idea why this means it doesn't get a newline.

somewhatabstract · 2024-12-19T00:23:26Z

utils/internal/pre-publish-utils.ts

+    // check that we are running our pre-publish check for this package
+    if (
+        !scripts.prepublishOnly ||
+        !scripts.prepublishOnly.includes("utils/package-pre-publish-check.sh")
+    ) {
+        console.error(
+            `ERROR: ${name} must have a "prepublishOnly" script that runs "utils/package-pre-publish-check.sh".`,
+        );
+        returnCode = false;
+    }


note: New check to make sure all the packages we publish are running our prepublish check to avoid snapshot releases usurping real releases.

somewhatabstract · 2024-12-19T00:23:44Z

utils/internal/pre-publish-utils.ts

        }
+    } else if (pkgJson[field] !== value) {


note: I just changed that nested if in an else to an else if.

somewhatabstract · 2024-12-19T00:26:19Z

utils/pre-publish-check-ci.ts

+            if (
+                !checkPrivate(pkgJson) &&
+                !checkPublishConfig(pkgJson) &&
+                !checkEntrypoints(pkgJson) &&
+                !checkSource(pkgJson)
+            ) {
+                allPassed = false;
            }
        }
+
+        // Exit only after we've processed all the packages.
+        if (!allPassed) {
+            process.exit(1);
+        }


note: This means we check all the packages for all the things before we quit, rather than quitting on the first error. Makes it easier to do changes to the overall checks and ensure compliance.

@somewhatabstract

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2034](#2034) [`8e9b2395d`](8e9b239) Thanks [@catandthemachines](https://github.com/catandthemachines)! - Removing final usage of createReactClass. - [#2025](#2025) [`b52310d1b`](b52310d) Thanks [@nishasy](https://github.com/nishasy)! - [SR] Linear graph - add grab handle description and aria lives - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - [#2033](#2033) [`881c0aac3`](881c0aa) Thanks [@nishasy](https://github.com/nishasy)! - [Interactive Graph][axis labels] Make default x & y axis labels TeX on load - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check ## @khanacademy/[email protected] ### Patch Changes - [#2034](#2034) [`8e9b2395d`](8e9b239) Thanks [@catandthemachines](https://github.com/catandthemachines)! - Removing final usage of createReactClass. - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - [#2033](#2033) [`881c0aac3`](881c0aa) Thanks [@nishasy](https://github.com/nishasy)! - [Interactive Graph][axis labels] Make default x & y axis labels TeX on load - Updated dependencies \[[`8e9b2395d`](8e9b239), [`b52310d1b`](b52310d), [`b80e7882b`](b80e788), [`881c0aac3`](881c0aa)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - [#2037](#2037) [`b80e7882b`](b80e788) Thanks [@somewhatabstract](https://github.com/somewhatabstract)! - Nothing has changed, but our action requires a changeset per package and I don't know how to do an infrastructure update like this and pass that check - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] ## @khanacademy/[email protected] ### Patch Changes - Updated dependencies \[[`b80e7882b`](b80e788)]: - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected] - @khanacademy/[email protected]

somewhatabstract added 3 commits December 18, 2024 17:54

Add prepublish checks to block releases of non-snapshot versions

774926b

Make prepublish checks run on all things and report, instead of faili…

4182157

…ng on first one

docs(changeset):

f721074

somewhatabstract self-assigned this Dec 19, 2024

somewhatabstract requested review from jandrade and a team December 19, 2024 00:09

docs(changeset): Nothing has changed, but our action requires a chang…

5dddee1

…eset per package and I don't know how to do an infrastructure update like this and pass that check

jeremywiebe approved these changes Dec 19, 2024

View reviewed changes

Check everything before we quit checking

165f468

somewhatabstract commented Dec 19, 2024

View reviewed changes

somewhatabstract merged commit b80e788 into main Dec 19, 2024
8 checks passed

somewhatabstract deleted the protectrelease branch December 19, 2024 00:29

khan-actions-bot mentioned this pull request Dec 19, 2024

Version Packages #2035

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add prepublish checks to block releases of non-snapshot versionsfirst one #2037

Add prepublish checks to block releases of non-snapshot versionsfirst one #2037

somewhatabstract commented Dec 19, 2024 •

edited

Loading

github-actions bot commented Dec 19, 2024 •

edited

Loading

github-actions bot commented Dec 19, 2024 •

edited

Loading

jeremywiebe Dec 19, 2024

jeremywiebe Dec 19, 2024

somewhatabstract Dec 19, 2024

somewhatabstract Dec 19, 2024

somewhatabstract Dec 19, 2024

somewhatabstract Dec 19, 2024

Add prepublish checks to block releases of non-snapshot versionsfirst one #2037

Add prepublish checks to block releases of non-snapshot versionsfirst one #2037

Conversation

somewhatabstract commented Dec 19, 2024 • edited Loading

Summary:

Test plan:

github-actions bot commented Dec 19, 2024 • edited Loading

npm Snapshot: Published

github-actions bot commented Dec 19, 2024 • edited Loading

jeremywiebe Dec 19, 2024

Choose a reason for hiding this comment

jeremywiebe Dec 19, 2024

Choose a reason for hiding this comment

somewhatabstract Dec 19, 2024

Choose a reason for hiding this comment

somewhatabstract Dec 19, 2024

Choose a reason for hiding this comment

somewhatabstract Dec 19, 2024

Choose a reason for hiding this comment

somewhatabstract Dec 19, 2024

Choose a reason for hiding this comment

somewhatabstract commented Dec 19, 2024 •

edited

Loading

github-actions bot commented Dec 19, 2024 •

edited

Loading

github-actions bot commented Dec 19, 2024 •

edited

Loading