ci: refactor: proceedIfBot

Author: libinvarghese

.github/jsTemplates/utils/jobs.ts

@@ -3,20 +3,12 @@ import { defaultJobMachine, bot } from './constants';
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const JOB = {
-  proceedIfBot: {
-    outputs: {
-      status: '${{ steps.check-author.conclusion }}',
-    },
+  dumpGithubContext: {
     ...defaultJobMachine,
-    steps: [
-      STEP.dumpContext('github'),
-      {
-        name: `Check if author is ${bot}`,
-        id: 'check-author',
-        if: `github.event.pull_request.user.login != '${bot}'`,
-        run: `echo Skip! Pull request created by \${{ github.event.pull_request.user.login }} not ${bot}
-exit 0`,
-      },
-    ],
+    steps: [STEP.dumpContext('github')],
+  },
+  proceedIfBot: {
+    if: `github.event.pull_request.user.login == '${bot}'`,
+    steps: [STEP.echo(`Pull request created by \${{ github.event.pull_request.user.login }} is ${bot}`)],
   },
 };

.github/jsTemplates/utils/steps.ts

@@ -164,6 +164,18 @@ export const changePRBaseFromMasterToDevelop: UsesStep = {
   },
 };
 
+export function echo(message: string, env?: { [key: string]: string }): RunStep {
+  const runStep: RunStep = {
+    run: `echo ${message}`,
+  };
+
+  if (env) {
+    runStep.env = env;
+  }
+
+  return runStep;
+}
+
 export function cancelWorkflow(workflow: number): UsesStep {
   return {
     uses: DEPENDENCIES['cancel-workflow-action'],

.github/jsTemplates/workflows/automerge.yml.ts

@@ -16,19 +16,15 @@ export = {
     },
   },
   jobs: {
-    'pre-automerge-bot': JOB.proceedIfBot,
+    'dump-github-context': JOB.dumpGithubContext,
+    'cancel-not-dependabot': JOB.proceedIfBot,
     // Ignore labels does not contain 'dependencies' || contains 'released'
     'cancel-released-label': {
-      needs: ['pre-automerge-bot'],
+      needs: ['cancel-not-dependabot'],
       ...defaultJobMachine,
-      if: `needs.pre-automerge-bot.outputs.status != 'success'
-&& contains( github.event.pull_request.labels.*.name, '${dependabotLabel}')
+      if: `contains( github.event.pull_request.labels.*.name, '${dependabotLabel}')
 && !contains( github.event.pull_request.labels.*.name, '${avoidMergeLabel}')`,
-      steps: [
-        {
-          run: `echo "There is no '${avoidMergeLabel}' label!"`,
-        },
-      ],
+      steps: [STEP.echo(`There is no '${avoidMergeLabel}' label!`)],
     },
     // Since we are looking for 2 labels ['dependencies' & <ecosystem>],
     // we get 2 runs of this workflow due to the 2 labelled trigger.
@@ -37,11 +33,7 @@ export = {
       needs: ['cancel-released-label'],
       ...defaultJobMachine,
       if: `github.event.action != 'labeled' || github.event.label.name != '${dependabotLabel}'`,
-      steps: [
-        {
-          run: `echo "There is no '${dependabotLabel}' label!"`,
-        },
-      ],
+      steps: [STEP.echo(`There is no '${dependabotLabel}' label!`)],
     },
     'github-action': {
       needs: ['cancel-dependencies-label'],

.github/jsTemplates/workflows/security-update.yml.ts

@@ -14,10 +14,9 @@ export = {
     },
   },
   jobs: {
-    'pre-pr-update-base': JOB.proceedIfBot,
+    'cancel-not-dependabot': JOB.proceedIfBot,
     'pr-update-base': {
-      needs: ['pre-pr-update-base'],
-      if: `needs.pre-pr-update-base.outputs.status != 'success'`,
+      needs: ['cancel-not-dependabot'],
       ...defaultJobMachine,
       steps: [STEP.changePRBaseFromMasterToDevelop],
     },

.github/workflows/automerge.yml

@@ -16,38 +16,33 @@ name: automerge-dependabot
     branches:
       - develop
 jobs:
-  pre-automerge-bot:
-    outputs:
-      status: '${{ steps.check-author.conclusion }}'
+  dump-github-context:
     runs-on: ubuntu-latest
     steps:
       - name: Dump github context
         env:
           GITHUB_CONTEXT: '${{ toJson(github) }}'
         run: echo "$GITHUB_CONTEXT"
-      - name: 'Check if author is dependabot[bot]'
-        id: check-author
-        if: 'github.event.pull_request.user.login != ''dependabot[bot]'''
-        run: |-
-          echo Skip! Pull request created by ${{ github.event.pull_request.user.login }} not dependabot[bot]
-          exit 0
+  cancel-not-dependabot:
+    if: 'github.event.pull_request.user.login == ''dependabot[bot]'''
+    steps:
+      - run: 'echo Pull request created by ${{ github.event.pull_request.user.login }} is dependabot[bot]'
   cancel-released-label:
     needs:
-      - pre-automerge-bot
+      - cancel-not-dependabot
     runs-on: ubuntu-latest
     if: |-
-      needs.pre-automerge-bot.outputs.status != 'success'
-      && contains( github.event.pull_request.labels.*.name, 'dependencies')
+      contains( github.event.pull_request.labels.*.name, 'dependencies')
       && !contains( github.event.pull_request.labels.*.name, 'released')
     steps:
-      - run: echo "There is no 'released' label!"
+      - run: echo There is no 'released' label!
   cancel-dependencies-label:
     needs:
       - cancel-released-label
     runs-on: ubuntu-latest
     if: github.event.action != 'labeled' || github.event.label.name != 'dependencies'
     steps:
-      - run: echo "There is no 'dependencies' label!"
+      - run: echo There is no 'dependencies' label!
   github-action:
     needs:
       - cancel-dependencies-label

.github/workflows/security-update.yml

@@ -14,25 +14,13 @@ name: security-update
     branches:
       - master
 jobs:
-  pre-pr-update-base:
-    outputs:
-      status: '${{ steps.check-author.conclusion }}'
-    runs-on: ubuntu-latest
+  cancel-not-dependabot:
+    if: 'github.event.pull_request.user.login == ''dependabot[bot]'''
     steps:
-      - name: Dump github context
-        env:
-          GITHUB_CONTEXT: '${{ toJson(github) }}'
-        run: echo "$GITHUB_CONTEXT"
-      - name: 'Check if author is dependabot[bot]'
-        id: check-author
-        if: 'github.event.pull_request.user.login != ''dependabot[bot]'''
-        run: |-
-          echo Skip! Pull request created by ${{ github.event.pull_request.user.login }} not dependabot[bot]
-          exit 0
+      - run: 'echo Pull request created by ${{ github.event.pull_request.user.login }} is dependabot[bot]'
   pr-update-base:
     needs:
-      - pre-pr-update-base
-    if: needs.pre-pr-update-base.outputs.status != 'success'
+      - cancel-not-dependabot
     runs-on: ubuntu-latest
     steps:
       - uses: a-b-r-o-w-n/check-base-branch-action@v1