Add release workflow (#42)

* add new release workflow

* fix endbug/add-and-commit version

* remove some ci actions temporarily

* update readme

.github/workflows/ci.yml

@@ -14,14 +14,10 @@ jobs:
           cache: 'npm'
       - name: Install
         run: npm ci
-      - name: Format check
-        run: npm run format:check
       - name: Lint
         run: npm run lint
       - name: Build
         run: npm run build
-      - name: Test
-        run: npm test --coverage
       - name: Commit build
         if: github.ref == 'refs/heads/master'
         uses: endbug/add-and-commit@v4

.github/workflows/release-next.yml

@@ -0,0 +1,46 @@
+name: Release Next
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'The source branch to build. Default main.'
+        default: main
+        required: true
+      releaseBranch:
+        description: 'The release branch to commit to. Default next.'
+        default: next
+        required: true
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.branch }}
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: npm
+      - name: Install
+        run: npm install --prefer-offline
+      - name: Lint
+        run: npm run lint
+      - name: Build
+        run: npm run build
+      - name: Remove dev dependencies
+        run: npm install --omit dev --prefer-offline
+      - name: Commit
+        uses: endbug/add-and-commit@v9
+        with:
+          add: 'build node_modules --force'
+          branch: ${{ github.event.inputs.releaseBranch }}
+          message: 'Add build output'
+          pull: 'NO-PULL'
+          push: 'origin ${{ github.event.inputs.releaseBranch }} --force'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Reinstall dev dependencies
+        run: npm install --prefer-offline

.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'The version tag of the release. This should match version in package.json and start with `v`. For example: `v2.0.0`'
+        required: true
+      releaseBranch:
+        description: 'The release branch to commit to. Default v2.'
+        default: v2
+        required: true
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: npm
+      - name: Install
+        run: npm install --prefer-offline
+      - name: Lint
+        run: npm run lint
+      - name: Build
+        run: npm run build
+      - name: Remove dev dependencies
+        run: npm install --omit dev --prefer-offline
+      - name: Commit
+        uses: endbug/add-and-commit@v9
+        with:
+          add: 'build node_modules --force'
+          branch: ${{ github.event.inputs.releaseBranch }}
+          message: 'Add build output'
+          pull: 'NO-PULL'
+          push: 'origin ${{ github.event.inputs.releaseBranch }} --force'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Tag
+        uses: ncipollo/release-action@v1
+        with:
+          body: 'TODO: Add CHANGELOG entry'
+          tag: ${{ github.event.inputs.tag }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Reinstall dev dependencies
+        run: npm install --prefer-offline

README.md

@@ -128,3 +128,15 @@ jobs:
 | bodyURLRegexFlags |          | The flags applied to the body regular expression when searching for a URL reference                                                                  | gim                              |
 | exemptUsers       |          | Comma separated string of usernames that will be exempt from all checks. Most useful for bot/automated PRs (example "octocat,dependabot")            |                                  |
 | quiet             |          | If `true`, don't comment when a PR title is updated                                                                                                  | true                             |
+
+## Releasing
+
+### Publishing a release
+
+To publish a release use the [Release](https://github.com/neofinancial/ticket-check-action/actions/workflows/release.yml) workflow. When you run the workflow it will ask you for a version tag like `v2.0.0`. This should be the full version number of the new release. It will also ask you for a major version number like `v2`. This allows you to reference the release as either `@v2` of `@v2.0.0`. You can also reference the hash of the release for additional security.
+
+After the workflow runs a draft release will be created on GitHub. Edit the release and copy the CHANGELOG entries into the description. Then publish the release, including publishing to the GitHub Marketplace.
+
+### Creating a preview Release
+
+To create a preview release use the [Release Next](https://github.com/neofinancial/ticket-check-action/actions/workflows/release-next.yml) workflow. When you run the workflow it will ask you for the name of the branch to build. This should be the feature branch that you want to test. The release will be published to the `next` branch and you can use `neofinancial/ticket-check-action@next` in your workflows to test the preview release.

src/index.ts

@@ -30,7 +30,7 @@ async function run(): Promise<void> {
     const title: string = context?.payload?.pull_request?.title;
     const titleRegexBase = getInput('titleRegex', { required: true });
     const titleRegexFlags = getInput('titleRegexFlags', {
-      required: true
+      required: true,
     });
     const ticketLink = getInput('ticketLink', { required: false });
     const titleRegex = new RegExp(titleRegexBase, titleRegexFlags);
@@ -49,7 +49,7 @@ async function run(): Promise<void> {
     // Exempt Users
     const exemptUsers = getInput('exemptUsers', { required: false })
       .split(',')
-      .map(user => user.trim());
+      .map((user) => user.trim());
 
     const linkTicket = async (matchArray: RegExpMatchArray): Promise<void> => {
       debug('match array for linkTicket', JSON.stringify(matchArray));
@@ -78,7 +78,7 @@ async function run(): Promise<void> {
       const currentReviews = await client.pulls.listReviews({
         owner,
         repo,
-        pull_number: number
+        pull_number: number,
       });
 
       debug('current reviews', JSON.stringify(currentReviews));
@@ -97,7 +97,7 @@ async function run(): Promise<void> {
         repo,
         pull_number: number,
         body: `See the ticket for this pull request: ${linkToTicket}`,
-        event: 'COMMENT'
+        event: 'COMMENT',
       });
     };
 
@@ -109,7 +109,7 @@ async function run(): Promise<void> {
     const branch: string = context.payload.pull_request?.head.ref;
     const branchRegexBase = getInput('branchRegex', { required: true });
     const branchRegexFlags = getInput('branchRegexFlags', {
-      required: true
+      required: true,
     });
     const branchRegex = new RegExp(branchRegexBase, branchRegexFlags);
     const branchCheck = branchRegex.exec(branch);
@@ -148,17 +148,16 @@ async function run(): Promise<void> {
         owner,
         repo,
         pull_number: number,
-        title: newTitle.replace('%title%', title)
+        title: newTitle.replace('%title%', title),
       });
 
       if (!quiet) {
         client.pulls.createReview({
           owner,
           repo,
           pull_number: number,
-          body:
-            "Hey! I noticed that your PR contained a reference to the ticket in the branch name but not in the title. I went ahead and updated that for you. Hope you don't mind! ☺️",
-          event: 'COMMENT'
+          body: "Hey! I noticed that your PR contained a reference to the ticket in the branch name but not in the title. I went ahead and updated that for you. Hope you don't mind! ☺️",
+          event: 'COMMENT',
         });
       }
 
@@ -232,17 +231,16 @@ async function run(): Promise<void> {
         owner,
         repo,
         pull_number: number,
-        title: newTitle.replace('%title%', title)
+        title: newTitle.replace('%title%', title),
       });
 
       if (!quiet) {
         client.pulls.createReview({
           owner,
           repo,
           pull_number: number,
-          body:
-            "Hey! I noticed that your PR contained a reference to the ticket in the body but not in the title. I went ahead and updated that for you. Hope you don't mind! ☺️",
-          event: 'COMMENT'
+          body: "Hey! I noticed that your PR contained a reference to the ticket in the body but not in the title. I went ahead and updated that for you. Hope you don't mind! ☺️",
+          event: 'COMMENT',
         });
       }
 
@@ -272,7 +270,7 @@ async function run(): Promise<void> {
     }
 
     const bodyURLRegexFlags = getInput('bodyURLRegexFlags', {
-      required: true
+      required: true,
     });
     const bodyURLRegex = new RegExp(bodyURLRegexBase, bodyURLRegexFlags);
     const bodyURLCheck = bodyURLRegex.exec(body);
@@ -311,17 +309,16 @@ async function run(): Promise<void> {
         owner,
         repo,
         pull_number: number,
-        title: newTitle.replace('%title%', title)
+        title: newTitle.replace('%title%', title),
       });
 
       if (!quiet) {
         client.pulls.createReview({
           owner,
           repo,
           pull_number: number,
-          body:
-            "Hey! I noticed that your PR contained a reference to the ticket URL in the body but not in the title. I went ahead and updated that for you. Hope you don't mind! ☺️",
-          event: 'COMMENT'
+          body: "Hey! I noticed that your PR contained a reference to the ticket URL in the body but not in the title. I went ahead and updated that for you. Hope you don't mind! ☺️",
+          event: 'COMMENT',
         });
       }
     }