add option to skip packages to deprecate and restore workflows

Author: sobolk

.github/workflows/deprecate_release.yml

@@ -21,6 +21,12 @@ on:
         description: |
           By default, the most recent release from HEAD (inclusive) of the target branch will be deprecated.
           To deprecate a different release, specify the release commit to deprecate here.
+      packagesToSkip:
+        required: false
+        type: string
+        default: []
+        description: |
+          JSON array with packages to skip. Empty by default.
 
 jobs:
   install:
@@ -47,6 +53,7 @@ jobs:
       INPUT_DEPRECATIONMESSAGE: ${{ inputs.deprecationMessage }}
       INPUT_USENPMREGISTRY: ${{ inputs.useNpmRegistry }}
       INPUT_SEARCHFORRELEASESTARTINGFROM: ${{ inputs.searchForReleaseStartingFrom }}
+      INPUT_PACKAGESTOSKIP: ${{ inputs.packagesToSkip }}
     steps:
       - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # version 4.1.4
         with:

.github/workflows/restore_release.yml

@@ -17,6 +17,12 @@ on:
         description: |
           By default, the most recent release from HEAD (inclusive) of the target branch will be restored.
           To restore a different release, specify the release commit to restore here.
+      packagesToSkip:
+        required: false
+        type: string
+        default: []
+        description: |
+          JSON array with packages to skip. Empty by default.
 
 jobs:
   install:
@@ -42,6 +48,7 @@ jobs:
       # mapping the inputs to these environment variables allows the @actions/core toolkit to pick up the inputs
       INPUT_USENPMREGISTRY: ${{ inputs.useNpmRegistry }}
       INPUT_SEARCHFORRELEASESTARTINGFROM: ${{ inputs.searchForReleaseStartingFrom }}
+      INPUT_PACKAGESTOSKIP: ${{ inputs.packagesToSkip }}
     steps:
       - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # version 4.1.4
         with:

scripts/components/git_client.ts

@@ -120,10 +120,19 @@ export class GitClient {
   /**
    * Returns a list of tags that point to the given commit
    */
-  getTagsAtCommit = async (commitHash: string) => {
+  getTagsAtCommit = async (
+    commitHash: string,
+    packagesToSkip?: Set<string>,
+  ) => {
     const { stdout: tagsString } = await this
       .exec`git tag --points-at ${commitHash}`;
-    return tagsString.split(EOL).filter((line) => line.trim().length > 0);
+    let tags = tagsString.split(EOL).filter((line) => line.trim().length > 0);
+    if (packagesToSkip) {
+      tags = tags.filter(
+        (tag) => !packagesToSkip.has(tag.substring(0, tag.indexOf('@'))),
+      );
+    }
+    return tags;
   };
 
   /**
@@ -159,9 +168,15 @@ export class GitClient {
    * This method will walk through past release tags until it finds the previous version of all of the input package versions
    * If a previous version of some package cannot be found, an error is thrown.
    */
-  getPreviousReleaseTags = async (releaseCommitHash: string) => {
+  getPreviousReleaseTags = async (
+    releaseCommitHash: string,
+    packagesToSkip: Set<string>,
+  ) => {
     await this.validateReleaseCommitHash(releaseCommitHash);
-    const releaseTags = await this.getTagsAtCommit(releaseCommitHash);
+    const releaseTags = await this.getTagsAtCommit(
+      releaseCommitHash,
+      packagesToSkip,
+    );
 
     // create a set of just the package names (strip off the version suffix) associated with this release commit
     const packageNamesRemaining = new Set(
@@ -175,22 +190,34 @@ export class GitClient {
     // the method return value that we will append release tags to in the loop
     const previousReleaseTags: string[] = [];
 
-    while (packageNamesRemaining.size > 0) {
-      releaseCommitCursor = await this.getNearestReleaseCommit(
-        releaseCommitCursor,
-        { inclusive: false },
+    try {
+      while (packageNamesRemaining.size > 0) {
+        releaseCommitCursor = await this.getNearestReleaseCommit(
+          releaseCommitCursor,
+          { inclusive: false },
+        );
+        const releaseTagsAtCursor = await this.getTagsAtCommit(
+          releaseCommitCursor,
+          packagesToSkip,
+        );
+        releaseTagsAtCursor.forEach((releaseTag) => {
+          const { packageName } = releaseTagToNameAndVersion(releaseTag);
+          if (packageNamesRemaining.has(packageName)) {
+            // this means we've found the previous version of "packageNameRemaining" that was released in releaseCommitHash
+            // so we add it to the return list and remove it from the search set
+            previousReleaseTags.push(releaseTag);
+            packageNamesRemaining.delete(packageName);
+          }
+        });
+      }
+    } catch (e) {
+      // In case error was thrown print out remaining packages.
+      packageNamesRemaining.forEach((packageName) =>
+        console.log(
+          `Unable to resolve previous release tags for ${packageName}`,
+        ),
       );
-      const releaseTagsAtCursor =
-        await this.getTagsAtCommit(releaseCommitCursor);
-      releaseTagsAtCursor.forEach((releaseTag) => {
-        const { packageName } = releaseTagToNameAndVersion(releaseTag);
-        if (packageNamesRemaining.has(packageName)) {
-          // this means we've found the previous version of "packageNameRemaining" that was released in releaseCommitHash
-          // so we add it to the return list and remove it from the search set
-          previousReleaseTags.push(releaseTag);
-          packageNamesRemaining.delete(packageName);
-        }
-      });
+      throw e;
     }
 
     return previousReleaseTags;

scripts/components/release_deprecator.ts

@@ -14,6 +14,7 @@ export class ReleaseDeprecator {
   constructor(
     private readonly gitRefToStartReleaseSearchFrom: string,
     private readonly deprecationMessage: string,
+    private readonly packagesToSkip: Set<string>,
     private readonly githubClient: GithubClient,
     private readonly gitClient: GitClient,
     private readonly npmClient: NpmClient,
@@ -41,10 +42,12 @@ export class ReleaseDeprecator {
 
     const releaseTagsToDeprecate = await this.gitClient.getTagsAtCommit(
       releaseCommitHashToDeprecate,
+      this.packagesToSkip,
     );
 
     const previousReleaseTags = await this.gitClient.getPreviousReleaseTags(
       releaseCommitHashToDeprecate,
+      this.packagesToSkip,
     );
 
     // Create the changeset revert PR

scripts/components/release_lifecycle.test.ts

@@ -29,6 +29,7 @@ void describe('release lifecycle', async () => {
 
   let cantaloupePackageName: string;
   let platypusPackageName: string;
+  let brandNewPackageName: string;
 
   before(async () => {
     await import('../start_npm_proxy.js');
@@ -43,10 +44,12 @@ void describe('release lifecycle', async () => {
    * It seeds the local npm proxy with a few releases of these packages.
    * When its done, the state of the git refs and npm dist-tags should be as follows:
    *
-   * third release commit                   ● <- HEAD, [email protected], cantaloupe@latest
+   * third release commit                   ● <- HEAD, [email protected], cantaloupe@latest, [email protected], brand-new-package@latest
    *                                        |
    * minor bump of cantaloupe only          ●
    *                                        |
+   * add brand-new-package                  ●
+   *                                        |
    * second release commit                  ● <- [email protected], platypus@latest
    *                                        |
    * minor bump of platypus only            ●
@@ -82,6 +85,8 @@ void describe('release lifecycle', async () => {
       `${testNameNormalized}-cantaloupe-${shortId}`.toLocaleLowerCase();
     platypusPackageName =
       `${testNameNormalized}-platypus-${shortId}`.toLocaleLowerCase();
+    brandNewPackageName =
+      `${testNameNormalized}-brand-new-package-${shortId}`.toLocaleLowerCase();
 
     await gitClient.init();
     await gitClient.switchToBranch('main');
@@ -123,6 +128,11 @@ void describe('release lifecycle', async () => {
     await gitClient.commitAllChanges('Version Packages (second release)');
     await runPublishInTestDir();
 
+    await npmClient.initWorkspacePackage(brandNewPackageName);
+    await setPackageToPublic(
+      path.join(testWorkingDir, 'packages', brandNewPackageName),
+    );
+
     await commitVersionBumpChangeset(
       testWorkingDir,
       gitClient,
@@ -146,6 +156,12 @@ void describe('release lifecycle', async () => {
       '1.2.0',
       'latest',
     );
+    await expectDistTagAtVersion(
+      npmClient,
+      brandNewPackageName,
+      '1.0.0',
+      'latest',
+    );
   });
 
   void it('can deprecate and restore packages using npm metadata', async () => {
@@ -158,6 +174,7 @@ void describe('release lifecycle', async () => {
     const releaseDeprecator1 = new ReleaseDeprecator(
       'HEAD',
       'the cantaloupe is rotten',
+      new Set([brandNewPackageName]), // skip brand-new package,
       githubClient,
       gitClient,
       npmClient,
@@ -185,6 +202,7 @@ void describe('release lifecycle', async () => {
     const releaseDeprecator2 = new ReleaseDeprecator(
       'HEAD~',
       'RIP platypus',
+      new Set([brandNewPackageName]), // skip brand-new package,
       githubClient,
       gitClient,
       npmClient,
@@ -213,6 +231,7 @@ void describe('release lifecycle', async () => {
     const releaseDeprecator3 = new ReleaseDeprecator(
       'HEAD~3',
       'real big mess',
+      new Set([brandNewPackageName]), // skip brand-new package,
       githubClient,
       gitClient,
       npmClient,
@@ -252,6 +271,7 @@ void describe('release lifecycle', async () => {
     await gitClient.switchToBranch('main');
     const releaseRestorer1 = new ReleaseRestorer(
       'HEAD~3',
+      new Set([brandNewPackageName]), // skip brand-new package,
       githubClient,
       gitClient,
       npmClient,
@@ -279,6 +299,7 @@ void describe('release lifecycle', async () => {
     await gitClient.switchToBranch('main');
     const releaseRestorer2 = new ReleaseRestorer(
       'HEAD~',
+      new Set([brandNewPackageName]), // skip brand-new package,
       githubClient,
       gitClient,
       npmClient,
@@ -299,6 +320,7 @@ void describe('release lifecycle', async () => {
     await gitClient.switchToBranch('main');
     const releaseRestorer3 = new ReleaseRestorer(
       'HEAD',
+      new Set([brandNewPackageName]), // skip brand-new package,
       githubClient,
       gitClient,
       npmClient,

scripts/components/release_restorer.ts

@@ -14,6 +14,7 @@ export class ReleaseRestorer {
    */
   constructor(
     private readonly gitRefToStartReleaseSearchFrom: string,
+    private readonly packagesToSkip: Set<string>,
     private readonly githubClient: GithubClient,
     private readonly gitClient: GitClient,
     private readonly npmClient: NpmClient,
@@ -39,10 +40,12 @@ export class ReleaseRestorer {
 
     const releaseTagsToRestore = await this.gitClient.getTagsAtCommit(
       releaseCommitHashToRestore,
+      this.packagesToSkip,
     );
 
     const previousReleaseTags = await this.gitClient.getPreviousReleaseTags(
       releaseCommitHashToRestore,
+      this.packagesToSkip,
     );
 
     // first create the changeset restore PR

scripts/deprecate_release.ts

@@ -31,9 +31,16 @@ const npmClient = new NpmClient(
 
 await npmClient.configureNpmRc();
 
+const packagesToSkipJSON = getInput('packagesToSkip', {
+  required: true,
+});
+
+const packagesToSkip = new Set(JSON.parse(packagesToSkipJSON) as Array<string>);
+
 const releaseDeprecator = new ReleaseDeprecator(
   searchForReleaseStartingFrom,
   deprecationMessage,
+  packagesToSkip,
   new GithubClient(),
   new GitClient(),
   npmClient,

scripts/publish_runner.ts

@@ -56,12 +56,12 @@ export const runPublish = async (props?: PublishOptions, cwd?: string) => {
   if (options.snapshotRelease) {
     if (fs.existsSync(path.join('.changeset', 'pre.json'))) {
       // Snapshot releases are not allowed in pre mode.
-      await execa('changeset', ['pre', 'exit'], execaOptions);
+      await execa('npx', ['changeset', 'pre', 'exit'], execaOptions);
     }
     await runVersion(['--snapshot', snapshotTag], cwd);
   }
 
-  const changesetArgs = ['publish'];
+  const changesetArgs = ['changeset', 'publish'];
   if (!options.includeGitTags) {
     changesetArgs.push('--no-git-tag');
   }
@@ -75,5 +75,5 @@ export const runPublish = async (props?: PublishOptions, cwd?: string) => {
       ? { env: { npm_config_registry: 'http://localhost:4873/' } }
       : {}),
   };
-  await execa('changeset', changesetArgs, execaPublishOptions);
+  await execa('npx', changesetArgs, execaPublishOptions);
 };

scripts/restore_release.ts

@@ -28,8 +28,15 @@ const npmClient = new NpmClient(
 
 await npmClient.configureNpmRc();
 
+const packagesToSkipJSON = getInput('packagesToSkip', {
+  required: true,
+});
+
+const packagesToSkip = new Set(JSON.parse(packagesToSkipJSON) as Array<string>);
+
 const releaseRestorer = new ReleaseRestorer(
   searchForReleaseStartingFrom,
+  packagesToSkip,
   new GithubClient(),
   new GitClient(),
   npmClient,

scripts/version_runner.ts

@@ -23,8 +23,8 @@ export const runVersion = async (
     );
   }
 
-  const args = ['version', ...additionalArgs];
-  await execa('changeset', args, {
+  const args = ['changeset', 'version', ...additionalArgs];
+  await execa('npx', args, {
     stdio: 'inherit',
     cwd,
   });