feat: add GitHub release action (#129)

Author: childish-sambino

.eslintrc.yml

@@ -0,0 +1,25 @@
+env:
+  browser: true
+  es2021: true
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/recommended
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+plugins:
+  - '@typescript-eslint'
+rules:
+  indent:
+    - error
+    - 2
+  linebreak-style:
+    - error
+    - unix
+  quotes:
+    - error
+    - double
+  semi:
+    - error
+    - always

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Checkout dx-automator
+        uses: actions/checkout@v2
+
+      - name: Set up Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build & Test
+        run: npm run all
+
+      - name: Show git status and fail on diff
+        run: |
+          git status
+          git diff
+          test -z "$(git status --porcelain)"

.gitignore

@@ -11,7 +11,6 @@ __pycache__/
 env/
 build/
 develop-eggs/
-dist/
 eggs/
 .eggs/
 lib/
@@ -43,6 +42,7 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+coverage/
 
 # Translations
 *.mo

actions/README.md

@@ -0,0 +1,48 @@
+# Actions
+
+## GitHubRelease
+
+A GitHub action to create or update a Release in GitHub.
+
+### Usage
+
+```yml
+      - name: Create a release
+        uses: sendgrid/dx-automator/actions/release@main
+        with:
+          changelog-filename: CHANGES.md
+          footer: This is a custom footer
+          assets: sendgrid-java.jar
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Action Inputs
+
+| Name                 | Description                                                | Default                        |
+|----------------------|------------------------------------------------------------|--------------------------------|
+| `changelog-filename` | Filename of the changelog file                             | `CHANGES.md` or `CHANGELOG.md` |
+| `footer`             | Custom release notes footer                                |                                |
+| `assets`             | Space-separated list of assets to include with the release |                                |
+
+The env var `GITHUB_TOKEN` must also be given which can be either `GITHUB_TOKEN` or a `repo`
+-scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
+
+The `footer` input supports limited string parameter expansion. The table below lists the string literals and what they
+will expand into.
+
+| Literal      | Value                                                  |
+|--------------|--------------------------------------------------------|
+| `${version}` | The version of the release (i.e., the name of the tag) |
+
+# Developing
+
+## Requirements
+
+* Node.js 12
+
+## Contributing
+
+Before submitting a pull request, run `npm run all` to build, format, lint, test the actions. This will also compile
+each action into a single file which is required in order to run them in GitHub workflows. Failure to do so will result
+in pull request check failures.

actions/release/ReleaseGitHub.test.ts

@@ -0,0 +1,273 @@
+import { describe, expect, jest, test } from "@jest/globals";
+import ReleaseGitHub, { ReleaseGitHubParams } from "./ReleaseGitHub";
+import { Context } from "@actions/github/lib/context";
+import path from "path";
+
+const mockGetReleaseByTag = jest.fn();
+const mockUpdateRelease = jest.fn();
+const mockCreateRelease = jest.fn();
+const mockListReleaseAssets = jest.fn();
+const mockDeleteReleaseAsset = jest.fn();
+const mockUploadReleaseAsset = jest.fn();
+
+jest.mock("@octokit/rest", () => ({
+  Octokit: jest.fn(() => ({
+    repos: {
+      getReleaseByTag: mockGetReleaseByTag,
+      updateRelease: mockUpdateRelease,
+      createRelease: mockCreateRelease,
+      listReleaseAssets: mockListReleaseAssets,
+      deleteReleaseAsset: mockDeleteReleaseAsset,
+      uploadReleaseAsset: mockUploadReleaseAsset,
+    },
+  })),
+}));
+
+process.chdir(path.join(__dirname, "fixtures"));
+
+describe("ReleaseGitHub", () => {
+  describe("run", () => {
+    const release = new ReleaseGitHub(
+      {
+        repo: { owner: "twilio", repo: "twilio-BASIC" },
+        ref: "refs/tags/2021.11.12",
+      } as Context,
+      {
+        assets: ["CHANGELOG.md"],
+      } as ReleaseGitHubParams
+    );
+
+    test("fully creates a release", async () => {
+      mockGetReleaseByTag.mockImplementation(() => {
+        throw new Error("NOT FOUND");
+      });
+      mockCreateRelease.mockReturnValue({ data: { id: 123 } });
+      mockListReleaseAssets.mockReturnValue({ data: [] });
+
+      await release.run();
+      expect(mockGetReleaseByTag).toHaveBeenCalledTimes(1);
+      expect(mockCreateRelease).toHaveBeenCalledTimes(1);
+      expect(mockListReleaseAssets).toHaveBeenCalledTimes(1);
+      expect(mockUploadReleaseAsset).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe("release", () => {
+    const release = new ReleaseGitHub(
+      { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+      {} as ReleaseGitHubParams
+    );
+
+    test("creates a new release", async () => {
+      mockGetReleaseByTag.mockImplementation(() => {
+        throw new Error("NOT FOUND");
+      });
+      mockCreateRelease.mockReturnValue({ data: { id: 123 } });
+
+      const releaseId = await release.release("1.2.3", "NOTES");
+      expect(releaseId).toEqual(123);
+      expect(mockGetReleaseByTag).toHaveBeenCalledTimes(1);
+      expect(mockCreateRelease).toHaveBeenCalledTimes(1);
+      expect(mockUpdateRelease).not.toHaveBeenCalled();
+
+      const getReleaseParams: any = mockGetReleaseByTag.mock.calls[0][0];
+      expect(getReleaseParams.tag).toEqual("1.2.3");
+
+      const createReleaseParams: any = mockCreateRelease.mock.calls[0][0];
+      expect(createReleaseParams.tag_name).toEqual("1.2.3");
+      expect(createReleaseParams.name).toEqual("1.2.3");
+      expect(createReleaseParams.body).toEqual("NOTES");
+    });
+
+    test("updates an existing release", async () => {
+      mockGetReleaseByTag.mockReturnValue({ data: { id: 123 } });
+      mockUpdateRelease.mockReturnValue({ data: { id: 123 } });
+
+      const releaseId = await release.release("1.2.3", "NOTES");
+      expect(releaseId).toEqual(123);
+      expect(mockGetReleaseByTag).toHaveBeenCalledTimes(1);
+      expect(mockUpdateRelease).toHaveBeenCalledTimes(1);
+      expect(mockCreateRelease).not.toHaveBeenCalled();
+
+      const updateReleaseParams: any = mockUpdateRelease.mock.calls[0][0];
+      expect(updateReleaseParams.release_id).toEqual(123);
+      expect(updateReleaseParams.tag_name).toEqual("1.2.3");
+      expect(updateReleaseParams.name).toEqual("1.2.3");
+      expect(updateReleaseParams.body).toEqual("NOTES");
+    });
+  });
+
+  describe("uploadAssets", () => {
+    const release = new ReleaseGitHub(
+      { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+      { assets: ["CHANGELOG.md"] } as ReleaseGitHubParams
+    );
+
+    test("uploads a new asset", async () => {
+      mockListReleaseAssets.mockReturnValue({ data: [] });
+
+      await release.uploadAssets(123);
+      expect(mockListReleaseAssets).toHaveBeenCalledTimes(1);
+      expect(mockUploadReleaseAsset).toHaveBeenCalledTimes(1);
+      expect(mockDeleteReleaseAsset).not.toHaveBeenCalled();
+
+      const params: any = mockUploadReleaseAsset.mock.calls[0][0];
+      expect(params.release_id).toEqual(123);
+      expect(params.name).toEqual("CHANGELOG.md");
+    });
+
+    test("deletes an existing asset", async () => {
+      mockListReleaseAssets.mockReturnValue({
+        data: [{ id: 456, name: "CHANGES.md" }],
+      });
+
+      await release.uploadAssets(123);
+      expect(mockListReleaseAssets).toHaveBeenCalledTimes(1);
+      expect(mockDeleteReleaseAsset).toHaveBeenCalledTimes(1);
+      expect(mockUploadReleaseAsset).toHaveBeenCalledTimes(1);
+
+      const params: any = mockDeleteReleaseAsset.mock.calls[0][0];
+      expect(params.release_id).toEqual(123);
+      expect(params.asset_id).toEqual(456);
+    });
+  });
+
+  describe("getVersion", () => {
+    test("parses a tag ref properly", () => {
+      const release = new ReleaseGitHub(
+        { ref: "refs/tags/1.2.3" } as Context,
+        {} as ReleaseGitHubParams
+      );
+
+      const version = release.getVersion();
+      expect(version).toEqual("1.2.3");
+    });
+
+    test("throws on branch refs", () => {
+      const release = new ReleaseGitHub(
+        { ref: "refs/heads/main" } as Context,
+        {} as ReleaseGitHubParams
+      );
+
+      expect(() => release.getVersion()).toThrow("Invalid ref");
+    });
+
+    test("throws on bad refs", () => {
+      const release = new ReleaseGitHub(
+        { ref: "bad-ref" } as Context,
+        {} as ReleaseGitHubParams
+      );
+
+      expect(() => release.getVersion()).toThrow("Invalid ref");
+    });
+  });
+
+  describe("getReleaseNotes", () => {
+    const release = new ReleaseGitHub(
+      { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+      {} as ReleaseGitHubParams
+    );
+
+    test("handles the newest release", () => {
+      const releaseNotes = release.getReleaseNotes("2021.11.12");
+      expect(releaseNotes).toContain("Added widget");
+      expect(releaseNotes).toContain("Updated docs");
+      expect(releaseNotes).toContain("twilio-BASIC/2021.11.12/index.html");
+      expect(releaseNotes).not.toContain("Added new thing");
+      expect(releaseNotes).not.toContain("2021.1.1");
+    });
+
+    test("handles the oldest release", () => {
+      const releaseNotes = release.getReleaseNotes("2021.1.1");
+      expect(releaseNotes).toContain("Added new thing");
+      expect(releaseNotes).toContain("Removed old thing");
+      expect(releaseNotes).not.toContain("Updated docs");
+    });
+
+    test("handles long (golang) versions", () => {
+      const releaseNotes = release.getReleaseNotes("v2021.11.12");
+      expect(releaseNotes).toContain("Release Notes");
+    });
+
+    test("throws when the version is not found", () => {
+      expect(() => release.getReleaseNotes("2021.10.11")).toThrow(
+        "not found in changelog"
+      );
+    });
+  });
+
+  describe("getChangelogLines", () => {
+    test("errors when the changelog does not exist", () => {
+      const release = new ReleaseGitHub(
+        {} as Context,
+        {
+          changelogFilename: "CHANGES.md",
+        } as ReleaseGitHubParams
+      );
+      expect(() => release.getChangelogLines()).toThrow("Failed to find");
+    });
+  });
+
+  describe("getFooter", () => {
+    test("contains the Twilio footer for Twilio repos", () => {
+      const release = new ReleaseGitHub(
+        { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+        {} as ReleaseGitHubParams
+      );
+      const footer = release.getFooter("1.2.3");
+      expect(footer).toHaveLength(1);
+      expect(footer[0]).toContain("twilio-BASIC/1.2.3/index.html");
+    });
+
+    test("uses a different footer for twilio-go", () => {
+      const release = new ReleaseGitHub(
+        { repo: { owner: "twilio", repo: "twilio-go" } } as Context,
+        {} as ReleaseGitHubParams
+      );
+      const footer = release.getFooter("1.2.3");
+      expect(footer).toHaveLength(1);
+      expect(footer[0]).toContain("github.com/twilio/[email protected]");
+    });
+
+    test("excludes the Twilio footer for non-Twilio repos", () => {
+      const release = new ReleaseGitHub(
+        { repo: { owner: "sendgrid", repo: "sendgrid-BASIC" } } as Context,
+        {} as ReleaseGitHubParams
+      );
+      const footer = release.getFooter("1.2.3");
+      expect(footer).toHaveLength(0);
+    });
+
+    test("includes a custom footer", () => {
+      const release = new ReleaseGitHub(
+        { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+        { customFooter: "this is just a test" } as ReleaseGitHubParams
+      );
+      const footer = release.getFooter("2021.11.12");
+      expect(footer).toHaveLength(2);
+      expect(footer[1]).toEqual("this is just a test");
+    });
+
+    test("expands expected variables in custom footer", () => {
+      const release = new ReleaseGitHub(
+        { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+        {
+          customFooter: "the version is ${version}, okay",
+        } as ReleaseGitHubParams
+      );
+      const footer = release.getFooter("1.2.3");
+      expect(footer).toHaveLength(2);
+      expect(footer[1]).toEqual("the version is 1.2.3, okay");
+    });
+
+    test("errors on unexpected variables in custom footer", () => {
+      const release = new ReleaseGitHub(
+        { repo: { owner: "twilio", repo: "twilio-BASIC" } } as Context,
+        {
+          customFooter: "the version is ${blur-sion}, okay",
+        } as ReleaseGitHubParams
+      );
+      expect(() => release.getFooter("1.2.3")).toThrow("Unexpected variable");
+    });
+  });
+});