Changesets Action Release Functionality

package.json

@@ -39,8 +39,8 @@
     "url": "https://github.com/seek-oss/skuba.git"
   },
   "devDependencies": {
-    "@changesets/cli": "2.18.0",
     "@changesets/get-github-info": "0.5.0",
+    "@changesets/types": "4.0.1",
     "@types/concurrently": "6.3.0",
     "@types/ejs": "3.1.0",
     "@types/express": "4.17.13",
@@ -59,6 +59,10 @@
     "type-fest": "2.5.2"
   },
   "dependencies": {
+    "@changesets/cli": "^2.18.0",
+    "@changesets/pre": "^1.0.7",
+    "@changesets/read": "^0.5.1",
+    "@manypkg/get-packages": "^1.1.3",
     "@octokit/rest": "^18.12.0",
     "@octokit/types": "^6.34.0",
     "@types/jest": "^27.0.1",
@@ -79,13 +83,16 @@
     "jest": "^27.1.0",
     "latest-version": "^5.1.0",
     "lodash.mergewith": "^4.6.2",
+    "mdast-util-to-string": "^3.1.0",
     "module-alias": "^2.2.2",
     "normalize-package-data": "^3.0.0",
     "npm-run-path": "^4.0.1",
     "npm-which": "^3.0.1",
     "picomatch": "^2.2.2",
     "prettier": "~2.4.1",
     "read-pkg-up": "^7.0.1",
+    "remark-parse": "^10.0.0",
+    "remark-stringify": "^10.0.1",
     "runtypes": "^6.0.0",
     "semantic-release": "^17.4.7",
     "serialize-error": "^8.0.1",
@@ -95,7 +102,8 @@
     "ts-node": "^9.1.1",
     "ts-node-dev": "^1.1.8",
     "tsconfig-seek": "1.0.2",
-    "typescript": "~4.4.4"
+    "typescript": "~4.4.4",
+    "unified": "^10.1.0"
   },
   "peerDependencies": {
     "skuba-dive": "1"

src/cli/changeset/coreAdapter.ts

@@ -0,0 +1,17 @@
+const inputs: Record<string, string | undefined> = {
+  publish: 'yarn changeset publish',
+  version: undefined,
+  commit: undefined,
+  title: undefined,
+};
+
+export const getInput = (name: string): string | undefined => inputs[name];
+
+// Maybe we could store these in a checkrun..?
+export const setFailed = (message: string) => {
+  // eslint-disable-next-line no-console
+  console.error(message);
+  throw new Error();
+};
+
+export const setOutput = (_key: string, _value: string) => {};

src/cli/changeset/gitUtils.ts

@@ -0,0 +1,68 @@
+// Adapted from https://github.com/changesets/action/blob/21240c3cd1d2efa2672d64e0235a03cf139b83e6/src/utils.ts
+
+import { exec } from 'utils/exec';
+
+import { execWithOutput } from './utils';
+
+// TODO probably try and make this configurable
+const getBotName = () => 'buildkite';
+
+export const setupUser = async () => {
+  await exec('git', 'config', '--global', 'user.name', getBotName());
+  await exec(
+    'git',
+    'config',
+    '--global',
+    'user.email',
+    `${getBotName()}@users.noreply.github.com`,
+  );
+};
+
+export const pullBranch = async (branch: string) => {
+  await exec('git', 'pull', 'origin', branch);
+};
+
+export const push = async (
+  branch: string,
+  { force }: { force?: boolean } = {},
+) => {
+  await exec(
+    'git',
+    ...['push', 'origin', `HEAD:${branch}`, force && '--force'].filter<string>(
+      Boolean as any,
+    ),
+  );
+};
+
+export const pushTags = async () => {
+  await exec('git', 'push', 'origin', '--tags');
+};
+
+export const switchToMaybeExistingBranch = async (branch: string) => {
+  const { stderr } = await execWithOutput('git', ['checkout', branch], {
+    ignoreReturnCode: true,
+  });
+  const isCreatingBranch = !(stderr as Error)
+    .toString()
+    .includes(`Switched to a new branch '${branch}'`);
+  if (isCreatingBranch) {
+    await exec('git', 'checkout', '-b', branch);
+  }
+};
+
+export const reset = async (
+  pathSpec: string,
+  mode: 'hard' | 'soft' | 'mixed' = 'hard',
+) => {
+  await exec('git', 'reset', `--${mode}`, pathSpec);
+};
+
+export const commitAll = async (message: string) => {
+  await exec('git', 'add', '.');
+  await exec('git', 'commit', '-m', message);
+};
+
+export const checkIfClean = async (): Promise<boolean> => {
+  const { stdout } = await execWithOutput('git', ['status', '--porcelain']);
+  return !(stdout as Array<unknown>).length;
+};

src/cli/changeset/githubAdapter.ts

@@ -0,0 +1,21 @@
+import { Octokit } from '@octokit/rest';
+import { getCurrentBranchRef, getHeadSha, getOwnerRepo } from 'utils/git';
+
+export const getOctokit = (token: string) => new Octokit({ auth: token });
+
+export const context = async (dir: string) => {
+  const [{ owner, repo }, currentBranchRef, headSha] = await Promise.all([
+    getOwnerRepo(dir),
+    getCurrentBranchRef(dir),
+    getHeadSha(dir),
+  ]);
+
+  return {
+    sha: headSha,
+    ref: currentBranchRef,
+    repo: {
+      repo,
+      owner,
+    },
+  };
+};

src/cli/changeset/index.ts

@@ -0,0 +1,5 @@
+import { init } from 'wrapper/testing/expressRequestListener';
+
+export const release = () => {
+  init();
+};

src/cli/changeset/init.ts

@@ -0,0 +1,109 @@
+// Adapted from https://github.com/changesets/action/blob/21240c3cd1d2efa2672d64e0235a03cf139b83e6/src/index.ts
+/* eslint-disable no-sync */
+/* eslint-disable no-console */
+import fs from 'fs-extra';
+
+import * as core from './coreAdapter';
+import * as gitUtils from './gitUtils';
+import readChangesetState from './readChangesetState';
+import { runPublish, runVersion } from './run';
+
+const getOptionalInput = (name: string) => core.getInput(name) || undefined;
+
+(async () => {
+  const githubToken = process.env.GITHUB_TOKEN;
+
+  if (!githubToken) {
+    core.setFailed('Please add the GITHUB_TOKEN to the changesets action');
+    return;
+  }
+
+  console.log('setting git user');
+  await gitUtils.setupUser();
+
+  console.log('setting GitHub credentials');
+  await fs.writeFile(
+    `${process.env.HOME as string}/.netrc`,
+    `machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`,
+  );
+
+  const { changesets } = await readChangesetState();
+
+  const publishScript = core.getInput('publish');
+  const hasChangesets = changesets.length !== 0;
+  const hasPublishScript = Boolean(publishScript);
+
+  core.setOutput('published', 'false');
+  core.setOutput('publishedPackages', '[]');
+  core.setOutput('hasChangesets', String(hasChangesets));
+
+  switch (true) {
+    case !hasChangesets && !hasPublishScript:
+      console.log('No changesets found');
+      return;
+    case !hasChangesets && hasPublishScript: {
+      console.log(
+        'No changesets found, attempting to publish any unpublished packages to npm',
+      );
+
+      const userNpmrcPath = `${process.env.HOME as string}/.npmrc`;
+      if (fs.existsSync(userNpmrcPath)) {
+        console.log('Found existing user .npmrc file');
+        const userNpmrcContent = await fs.readFile(userNpmrcPath, 'utf8');
+        const authLine = userNpmrcContent.split('\n').find((line) =>
+          // check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
+          /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line),
+        );
+        if (authLine) {
+          console.log(
+            'Found existing auth token for the npm registry in the user .npmrc file',
+          );
+        } else {
+          console.log(
+            "Didn't find existing auth token for the npm registry in the user .npmrc file, creating one",
+          );
+          fs.appendFileSync(
+            userNpmrcPath,
+            `\n//registry.npmjs.org/:_authToken=${
+              process.env.NPM_TOKEN as string
+            }\n`,
+          );
+        }
+      } else {
+        console.log('No user .npmrc file found, creating one');
+        fs.writeFileSync(
+          userNpmrcPath,
+          `//registry.npmjs.org/:_authToken=${
+            process.env.NPM_TOKEN as string
+          }\n`,
+        );
+      }
+
+      const result = await runPublish({
+        script: publishScript as string,
+        githubToken,
+      });
+
+      if (result.published) {
+        core.setOutput('published', 'true');
+        core.setOutput(
+          'publishedPackages',
+          JSON.stringify(result.publishedPackages),
+        );
+      }
+      return;
+    }
+    case hasChangesets:
+      await runVersion({
+        script: getOptionalInput('version'),
+        githubToken,
+        prTitle: getOptionalInput('title'),
+        commitMessage: getOptionalInput('commit'),
+        hasPublishScript,
+      });
+      return;
+  }
+})().catch((err: unknown) => {
+  console.error(err);
+  core.setFailed((err as Error).message);
+});

src/cli/changeset/readChangesetState.ts

@@ -0,0 +1,29 @@
+// Adapted from https://github.com/changesets/action/blob/21240c3cd1d2efa2672d64e0235a03cf139b83e6/src/readChangesetState.ts
+
+import { readPreState } from '@changesets/pre';
+import readChangesets from '@changesets/read';
+import type { NewChangeset, PreState } from '@changesets/types';
+
+export type ChangesetState = {
+  preState: PreState | undefined;
+  changesets: NewChangeset[];
+};
+
+export default async function readChangesetState(
+  cwd: string = process.cwd(),
+): Promise<ChangesetState> {
+  const preState = await readPreState(cwd);
+  const isInPreMode = preState !== undefined && preState.mode === 'pre';
+
+  let changesets = await readChangesets(cwd);
+
+  if (isInPreMode) {
+    const changesetsToFilter = new Set(preState.changesets);
+    changesets = changesets.filter((x) => !changesetsToFilter.has(x.id));
+  }
+
+  return {
+    preState: isInPreMode ? preState : undefined,
+    changesets,
+  };
+}