Update for releases

farmersdog · Nov 11, 2020 · 3989b12 · 3989b12
1 parent 4207629
commit 3989b12
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 38 deletions.
diff --git a/.github/workflows/testRunAction.yml → .github/workflows/testPrerelease.yml b/.github/workflows/testRunAction.yml → .github/workflows/testPrerelease.yml
@@ -3,7 +3,6 @@ on:
   push:
     tags:
       - '*'
-
 jobs:
   prerelease:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/testRelease.yml b/.github/workflows/testRelease.yml
@@ -0,0 +1,20 @@
+name: On Release
+on:
+  release:
+    types: ['released']
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          path: action
+      - name: Fetch Latest Release
+        uses: thebritican/fetch-latest-release@v2.0.0
+        id: latestRelease
+      - name: Test farmersdog/release action
+        uses: './action'
+        with:
+          ghToken: ${{ secrets.GITHUB_TOKEN }}
+          prerelease: 'false'
diff --git a/README.md b/README.md
@@ -36,14 +36,15 @@ Run `yarn lint:watch` to watch for ESLint errors/warnings.
 
 ## Example usage
 
+### Prerelease
+
 ```
 on:
   push:
     tags:
       - '*'
-```
+...
 
-```
 uses: actions/release@v1
 with:
   ghToken: ${{ secrets.GITHUB_TOKEN }}
@@ -52,3 +53,21 @@ with:
   ## prerelease: false # default is true
   previousTag: "v0.0.9"
 ```
+
+### Release
+
+One might want to create a simple make command that triggers this workflow from the command line or a slack notification
+that allows this to be triggered.
+
+```
+on:
+  release:
+    types: ['released']
+...
+
+uses: actions/release@v1
+with:
+  ghToken: ${{ secrets.GITHUB_TOKEN }}
+  tag: ${{ github.event.release.tag_name }}
+  prerelease: false
+```
diff --git a/action.yml b/action.yml
@@ -6,7 +6,6 @@ inputs:
     required: true
   chStoryUrl:
     description: 'Clubhouse URL (ie. https://app.clubhouse.io/org/story)'
-    required: true
   tag:
     description: 'Github tag'
     required: true

diff --git a/dist/index.js b/dist/index.js
@@ -95,6 +95,7 @@ async function run() {
   try {
     const previousTag = core.getInput('previousTag');
     const prerelease = core.getInput('prerelease');
+    const isPreRelease = prerelease === 'true';
     const ghToken = core.getInput('ghToken');
     const chStoryUrl = core.getInput('chStoryUrl');
     const { ref } = github.context;
@@ -105,13 +106,7 @@ async function run() {
       return core.setFailed('Must provide ghToken');
     }
 
-    if (!chStoryUrl) {
-      return core.setFailed('Must provide chStoryUrl');
-    }
-
-    // Mask tokens:
     core.setSecret('ghToken');
-    core.setSecret('chStoryUrl');
 
     if (!validTag || !validTag.groups.tag) {
       return core.setFailed('Tag must follow format rules: v##.##.##');
@@ -120,20 +115,28 @@ async function run() {
     const {
       groups: { tag },
     } = validTag;
+    const octokit = github.getOctokit(ghToken);
+
+    core.info(
+      `Tag ${tag}: Creating a ${isPreRelease ? 'prerelease' : 'release'}...`
+    );
+
+    /* CREATE PRERELEASE */
+    if (isPreRelease) {
+      // CH Story URL is required for prerelease
+      if (!chStoryUrl) {
+        return core.setFailed('Must provide chStoryUrl');
+      }
 
-    // Create prerelease
-    // Note on bools: https://github.com/actions/toolkit/issues/361
-    if (prerelease === 'true') {
+      core.setSecret('chStoryUrl');
+
+      // Previous Tag is required for prerelease
       if (!previousTag) {
         return core.setFailed(
           'Must provide a previousTag to create a prerelease'
         );
       }
 
-      core.info(`Tag ${tag}: Creating a prerelease...`);
-
-      // Get list of commits
-      const octokit = github.getOctokit(ghToken);
       const {
         data: { commits },
       } = await octokit.repos.compareCommits({
@@ -144,8 +147,8 @@ async function run() {
 
       const formattedCommits = formatCommits(commits);
       const changelog = generateChangelog(formattedCommits);
+
       core.info(changelog);
-      // Create a github release (type: prerelease) w/ changelog attached
 
       return await octokit.repos.createRelease({
         ...github.context.repo,
@@ -156,9 +159,13 @@ async function run() {
       });
     }
 
-    // If already a prerelease, move to release state
-    if (prerelease === 'false') {
-      core.info('hello');
+    /* UPDATE PRERELEASE TO RELEASE */
+    if (!isPreRelease) {
+      return await octokit.repos.updateRelease({
+        ...github.context.repo,
+        tag_name: tag,
+        prerelease: false,
+      });
     }
 
     return core.setFailed(

diff --git a/index.js b/index.js
@@ -79,6 +79,7 @@ export async function run() {
   try {
     const previousTag = core.getInput('previousTag');
     const prerelease = core.getInput('prerelease');
+    const isPreRelease = prerelease === 'true';
     const ghToken = core.getInput('ghToken');
     const chStoryUrl = core.getInput('chStoryUrl');
     const { ref } = github.context;
@@ -89,13 +90,7 @@ export async function run() {
       return core.setFailed('Must provide ghToken');
     }
 
-    if (!chStoryUrl) {
-      return core.setFailed('Must provide chStoryUrl');
-    }
-
-    // Mask tokens:
     core.setSecret('ghToken');
-    core.setSecret('chStoryUrl');
 
     if (!validTag || !validTag.groups.tag) {
       return core.setFailed('Tag must follow format rules: v##.##.##');
@@ -104,20 +99,28 @@ export async function run() {
     const {
       groups: { tag },
     } = validTag;
+    const octokit = github.getOctokit(ghToken);
+
+    core.info(
+      `Tag ${tag}: Creating a ${isPreRelease ? 'prerelease' : 'release'}...`
+    );
+
+    /* CREATE PRERELEASE */
+    if (isPreRelease) {
+      // CH Story URL is required for prerelease
+      if (!chStoryUrl) {
+        return core.setFailed('Must provide chStoryUrl');
+      }
 
-    // Create prerelease
-    // Note on bools: https://github.com/actions/toolkit/issues/361
-    if (prerelease === 'true') {
+      core.setSecret('chStoryUrl');
+
+      // Previous Tag is required for prerelease
       if (!previousTag) {
         return core.setFailed(
           'Must provide a previousTag to create a prerelease'
         );
       }
 
-      core.info(`Tag ${tag}: Creating a prerelease...`);
-
-      // Get list of commits
-      const octokit = github.getOctokit(ghToken);
       const {
         data: { commits },
       } = await octokit.repos.compareCommits({
@@ -128,8 +131,8 @@ export async function run() {
 
       const formattedCommits = formatCommits(commits);
       const changelog = generateChangelog(formattedCommits);
+
       core.info(changelog);
-      // Create a github release (type: prerelease) w/ changelog attached
 
       return await octokit.repos.createRelease({
         ...github.context.repo,
@@ -140,9 +143,13 @@ export async function run() {
       });
     }
 
-    // If already a prerelease, move to release state
-    if (prerelease === 'false') {
-      core.info('hello');
+    /* UPDATE PRERELEASE TO RELEASE */
+    if (!isPreRelease) {
+      return await octokit.repos.updateRelease({
+        ...github.context.repo,
+        tag_name: tag,
+        prerelease: false,
+      });
     }
 
     return core.setFailed(

diff --git a/index.test.js b/index.test.js
@@ -151,5 +151,28 @@ describe('Release', () => {
         );
       });
     });
+
+    describe('on release', () => {
+      beforeEach(() => {
+        // Reset inputs
+        inputs = {};
+      });
+
+      test('should call core.info', async () => {
+        github.context.ref = 'refs/tags/v20.0.0';
+        inputs = {
+          chStoryUrl,
+          ghToken: '123',
+          prerelease: 'false',
+          previousTag: 'v20.0.0',
+        };
+
+        await run();
+
+        expect(core.info).toHaveBeenCalledWith(
+          'Tag v20.0.0: Creating a release...'
+        );
+      });
+    });
   });
 });
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,6 @@ on: @@
       push:
         tags:
           - '*'
     jobs:
       prerelease:
         runs-on: ubuntu-latest
@@ Expand Down @@