feat: add preview command to covector

.changes/preview-action-bump.md

@@ -1,5 +1,7 @@
 ---
-"action": patch
+"action": minor
+"covector": minor
+"apply": minor
 ---
 
-Add 'preview' command for action
+Add preview command for versioning and publishing preview packages

.github/workflows/run-version-or-publish.yml

@@ -43,6 +43,6 @@ jobs:
         with:
           title: "Publish New Versions"
           commit-message: "publish new versions"
-          labels: "version updates"
+          labels: "version updates, preview"
           branch: "release"
           body: ${{ steps.covector.outputs.change }}

__fixtures__/integration.js-only/.changes/config.json

@@ -0,0 +1,19 @@
+{
+  "pkgManagers": {
+    "javascript": {
+      "version": true,
+      "publish": "echo publishing ${ pkg.pkg } would happen here"
+    }
+  },
+  "packages": {
+    "package-a": {
+      "path": "./package-a",
+      "manager": "javascript",
+      "dependencies": ["package-b"]
+    },
+    "package-b": {
+      "path": "./package-b",
+      "manager": "javascript"
+    }
+  }
+}

__fixtures__/integration.js-only/.changes/first-change.md

@@ -0,0 +1,5 @@
+---
+"package-b": minor
+---
+
+Whatever

__fixtures__/integration.js-only/package-a/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "package-a",
+  "version": "0.0.1",
+  "dependencies": {
+    "package-b": "0.0.1"
+  }
+}

__fixtures__/integration.js-only/package-b/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "package-b",
+  "version": "0.0.1",
+  "dependencies": {}
+}

packages/action/action.yml

@@ -24,6 +24,18 @@ inputs:
     description: A comma separated list (no spaces) of packages to run commands on rather than everything listed in the config.
     required: false
     default: ""
+  label:
+    description: "the Github pull request label that triggers preview packages"
+    required: false
+    default: preview
+  previewVersion:
+    description: Template for how the preview packages should be versioned
+    required: false
+    default: date
+  identifier:
+    description: Identifier for prerelease version template
+    required: false
+    default: branch
 outputs:
   change:
     description: The changes that were applied

packages/action/src/index.ts

@@ -105,45 +105,65 @@ export function* run(): Generator<any, any, any> {
         return covectored;
       }
     } else if (command === "preview") {
-      const previewLabel = github?.context?.payload?.pull_request?.labels?.filter(({ name } : { name: String }) => name === 'preview').length;
+      const configuredLabel = core.getInput("label");
+      const previewLabel = github?.context?.payload?.pull_request?.labels?.filter(({ name } : { name: String }) => name === configuredLabel).length;
+      const previewVersion = core.getInput("previewVersion");
+      const versionIdentifier = core.getInput('identifier');
+
+      if (github.context.eventName !== "pull_request") {
+        throw new Error(`The 'preview' command for the covector action is only meant to run on pull requests.`);
+      }
+
       if (!previewLabel) {
-        console.log('Not publishing any preview packages because the "preview" label has not been applied to this pull request.')
+        console.log(`Not publishing any preview packages because the "${configuredLabel}" label has not been applied to this pull request.`);
       } else {
         let covectored: Covector;
-        // if (core.getInput("createRelease") === "true" && token) {
-        //   const octokit = github.getOctokit(token);
-        //   const { owner, repo } = github.context.repo;
-        //   covectored = yield covector({
-        //     command,
-        //     filterPackages,
-        //     cwd,
-        //     modifyConfig: injectPublishFunctions([
-        //       createReleases({ core, octokit, owner, repo }),
-        //     ]),
-        //   });
-        // } else {
-          covectored = yield covector({
-            command,
-            filterPackages,
-            cwd,
-          });
-        // }
+        const branchName = github?.context?.payload?.pull_request?.head?.ref;
+        let identifier;
+        let versionTemplate;
+
+        switch(versionIdentifier){
+          case "branch":
+            identifier = branchName.replace(/\_/g, '-').replace(/\//g, '-');
+            break;
+          default:
+            throw new Error(`Version identifier you specified, "${versionIdentifier}", is invalid.`)
+        }
 
-        // if (covectored) {
-        //   let packagesPublished = Object.keys(covectored).reduce((pub, pkg) => {
-        //     if (!covectored[pkg].published) {
-        //       return pub;
-        //     } else {
-        //       return `${pub}${pkg}`;
-        //     }
-        //   }, "");
-        //   core.setOutput("packagesPublished", packagesPublished);
-          // for (let pkg of Object.keys(covectored)) {
-          //   if (covectored[pkg].command !== false) successfulPublish = true;
-          // }
-          // core.setOutput("successfulPublish", successfulPublish);
-          // core.setOutput("change", covectored);
-        // }
+        switch(previewVersion){
+          case "date":
+            versionTemplate = `${identifier}.${Date.now()}`;
+            break;
+          case "sha":
+            versionTemplate = `${identifier}.${github.context.payload.after.substring(0, 7)}`;
+            break;
+          default:
+            throw new Error(`Preview version template you specified, "${previewVersion}", is invalid. Please use 'date' or 'sha'.`)
+        };
+
+        covectored = yield covector({
+          command,
+          filterPackages,
+          cwd,
+          // context: github.context.payload,
+          previewVersion: versionTemplate
+        });
+
+        if (covectored) {
+          let packagesPublished = Object.keys(covectored).reduce((pub, pkg) => {
+            if (!covectored[pkg].published) {
+              return pub;
+            } else {
+              return `${pub}${pkg}`;
+            }
+          }, "");
+          core.setOutput("packagesPublished", packagesPublished);
+          for (let pkg of Object.keys(covectored)) {
+            if (covectored[pkg].command !== false) successfulPublish = true;
+          }
+          core.setOutput("successfulPublish", successfulPublish);
+          core.setOutput("change", covectored);
+        }
       }
     } else {
       throw new Error(`Command "${command}" not recognized. See README for which commands are available.`);

packages/apply/__snapshots__/index.test.ts.snap

@@ -245,7 +245,17 @@ Object {
 }
 `;
 
-exports[`package file apply bump bumps multi js json 1`] = `
+exports[`package file apply bump (async/await) bumps multi rust toml as minor with object dep without version number 1`] = `
+Object {
+  "consoleError": Array [
+    Array [
+      "It appears that a dependency within this repo does not have a version specified.",
+    ],
+  ],
+}
+`;
+
+exports[`package file apply bump (snapshot) bumps multi js json 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
@@ -259,7 +269,7 @@ Object {
 }
 `;
 
-exports[`package file apply bump bumps multi rust toml 1`] = `
+exports[`package file apply bump (snapshot) bumps multi rust toml 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
@@ -273,7 +283,7 @@ Object {
 }
 `;
 
-exports[`package file apply bump bumps multi rust toml as minor with object dep missing patch 1`] = `
+exports[`package file apply bump (snapshot) bumps multi rust toml as minor with object dep missing patch 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
@@ -287,31 +297,35 @@ Object {
 }
 `;
 
-exports[`package file apply bump bumps multi rust toml as minor with object dep without version number 1`] = `
+exports[`package file apply bump (snapshot) bumps multi rust toml as patch with object dep missing patch 1`] = `
 Object {
-  "consoleError": Array [
+  "consoleDir": Array [],
+  "consoleLog": Array [
     Array [
-      "It appears that a dependency within this repo does not have a version specified.",
+      "bumping rust_pkg_a_fixture with patch",
+    ],
+    Array [
+      "bumping rust_pkg_b_fixture with patch",
     ],
   ],
 }
 `;
 
-exports[`package file apply bump bumps multi rust toml as patch with object dep missing patch 1`] = `
+exports[`package file apply bump (snapshot) bumps multi rust toml with dep missing patch 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
     Array [
-      "bumping rust_pkg_a_fixture with patch",
+      "bumping rust_pkg_a_fixture with minor",
     ],
     Array [
-      "bumping rust_pkg_b_fixture with patch",
+      "bumping rust_pkg_b_fixture with minor",
     ],
   ],
 }
 `;
 
-exports[`package file apply bump bumps multi rust toml with dep missing patch 1`] = `
+exports[`package file apply bump (snapshot) bumps multi rust toml with object dep 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
@@ -325,37 +339,48 @@ Object {
 }
 `;
 
-exports[`package file apply bump bumps multi rust toml with object dep 1`] = `
+exports[`package file apply bump (snapshot) bumps single js json 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
     Array [
-      "bumping rust_pkg_a_fixture with minor",
+      "bumping js-single-json-fixture with minor",
     ],
+  ],
+}
+`;
+
+exports[`package file apply bump (snapshot) bumps single rust toml 1`] = `
+Object {
+  "consoleDir": Array [],
+  "consoleLog": Array [
     Array [
-      "bumping rust_pkg_b_fixture with minor",
+      "bumping rust-single-fixture with minor",
     ],
   ],
 }
 `;
 
-exports[`package file apply bump bumps single js json 1`] = `
+exports[`packge file applies preview bump bumps multi js json 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
     Array [
-      "bumping js-single-json-fixture with minor",
+      "bumping yarn-workspace-base-pkg-a to 1.0.0-branch-name.12345 to publish a preview",
+    ],
+    Array [
+      "bumping yarn-workspace-base-pkg-b to 1.0.0-branch-name.12345 to publish a preview",
     ],
   ],
 }
 `;
 
-exports[`package file apply bump bumps single rust toml 1`] = `
+exports[`packge file applies preview bump bumps single js json 1`] = `
 Object {
   "consoleDir": Array [],
   "consoleLog": Array [
     Array [
-      "bumping rust-single-fixture with minor",
+      "bumping js-single-json-fixture to 0.5.9-branch-name.12345 to publish a preview",
     ],
   ],
 }