improve regex, add link-required

Author: hcliff

README.md

@@ -12,11 +12,15 @@ This action integrates asana with github.
 
 ### `asana-pat`
 
-**Required** Your public access token of asana, you can find it in [asana docs](https://developers.asana.com/docs/#authentication-basics).
+**Required** Your public access token of asana, you can generate one [here](https://app.asana.com/0/developer-console).
+
+### `github-token`
+
+**Required** A github auth token (used to set statuses)
 
 ### `trigger-phrase`
 
-**Required** Prefix before the task i.e ASANA TASK: https://app.asana.com/1/2/3/.
+**Optional** Prefix before the task i.e ASANA TASK: https://app.asana.com/1/2/3/.
 
 ### `task-comment`
 
@@ -30,14 +34,49 @@ targets: '[{"project": "Backlog", "section": "Development Done"}, {"project": "C
 ```
 if you don't want to move task omit `targets`.
 
+### `link-required`
+
+**Optional** When set to true will fail pull requests without an asana link
 
 ## Example usage
 
 ```yaml
-uses: https://github.com/insurify/[email protected]
-with:
-  asana-pat: 'Your PAT'
-  task-comment: 'View Pull Request Here: '
-  trigger-phrase: 'Asana Task:'
-  targets: '[{"project": "Backlog", "section": "Development Done"}, {"project": "Current Sprint", "section": "In Review"}]'
+name: Mark asana task as done
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: everphone-gmbh/[email protected]
+        if: github.event.pull_request.merged
+        with:
+          asana-pat: ${{ secrets.ASANA_PAT }}
+          targets: '[{"project": "Engineering scrum", "section": "Done"}]'
+          link-required: false
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+```yaml
+name: Add asana link
+
+on:
+  pull_request:
+    types: [opened, edited, labeled, unlabeled]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: everphone-gmbh/[email protected]
+        with:
+          asana-pat: ${{ secrets.ASANA_PAT }}
+          task-comment: 'View Pull Request Here: '
+          # if the branch is labeled or named a hotfix, skip this check
+          link-required: ${{ !contains(github.event.pull_request.labels.*.name, 'hotfix') && !startsWith(github.event.pull_request.title,'hotfix/') }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
 ```

action.yml

@@ -1,4 +1,4 @@
-name: 'Asana Git'
+name: 'Asana Git with enforcement'
 description: 'Asana Github Actions'
 inputs:
   asana-pat:
@@ -12,6 +12,13 @@ inputs:
     required: false
   trigger-phrase:
     description: 'Prefix before the task i.e ASANA TASK: https://app.asana.com/1/2/3'
+    required: false
+  link-required:
+    description: 'When set to true requires an asana link in the body'
+    required: false
+    default: false
+  github-token:
+    description: 'your github auth token'
     required: true
 branding:
   icon: 'chevron-right'  

index.js

@@ -38,39 +38,63 @@ async function asanaOperations(
       });
       core.info('Added the pull request link to the Asana task.');
     }
-  } catch (ex) {
-    console.error(ex.value);
+  } catch (error) {
+    core.error(error.value);
   }
 }
 
-try {
-  const ASANA_PAT = core.getInput('asana-pat'),
-    TARGETS = core.getInput('targets'),
-    TRIGGER_PHRASE = core.getInput('trigger-phrase'),
-    TASK_COMMENT = core.getInput('task-comment'),
-    PULL_REQUEST = github.context.payload.pull_request,
-    REGEX_STRING = `\\*\\*${TRIGGER_PHRASE}\\*\\* \\[(.*?)\\]\\(https:\\/\\/app.asana.com\\/(\\d+)\\/(?<project>\\d+)\\/(?<task>\\d+).*?\\)`,
-    REGEX = new RegExp(REGEX_STRING,'g');
-  core.info(`Regex: ${REGEX_STRING}`);
-  core.info(`pr body: ${PULL_REQUEST.body}`);
-  let taskComment = null,
-    targets = TARGETS? JSON.parse(TARGETS) : [],
-    parseAsanaURL = null;
+async function run() {
+  try {
+    const GITHUB_TOKEN = core.getInput('github-token', {required: true});
+      ASANA_PAT = core.getInput('asana-pat', {required: true}),
+      TARGETS = core.getInput('targets'),
+      TRIGGER_PHRASE = core.getInput('trigger-phrase'),
+      TASK_COMMENT = core.getInput('task-comment'),
+      PULL_REQUEST = github.context.payload.pull_request,
+      REGEX_STRING = `${TRIGGER_PHRASE}(?:\s*)https:\\/\\/app.asana.com\\/(\\d+)\\/(?<project>\\d+)\\/(?<task>\\d+)`,
+      REGEX = new RegExp(REGEX_STRING,'g'),
+      // all inputs are strings
+      LINK_REQUIRED = core.getInput('link-required') === 'true'
+    ;
 
-  if (!ASANA_PAT){
-    throw({message: 'ASANA PAT Not Found!'});
-  }
-  if (TASK_COMMENT) {
-    taskComment = `${TASK_COMMENT} ${PULL_REQUEST.html_url}`;
-  }
-  while ((parseAsanaURL = REGEX.exec(PULL_REQUEST.body)) !== null) {
-    let taskId = parseAsanaURL.groups.task;
-    if (taskId) {
-      asanaOperations(ASANA_PAT, targets, taskId, taskComment);
-    } else {
-      core.info(`Invalid Asana task URL after the trigger phrase ${TRIGGER_PHRASE}`);
+    const octokit = new github.GitHub(GITHUB_TOKEN);
+
+    core.debug(`Regex: ${REGEX_STRING}`);
+    // contains the markdown version of the PR
+    core.debug(`pr body: ${PULL_REQUEST.body}`);
+
+    let taskComment = null,
+      targets = TARGETS ? JSON.parse(TARGETS) : [],
+      parseAsanaURL = null;
+
+    if (TASK_COMMENT) {
+      taskComment = `${TASK_COMMENT} ${PULL_REQUEST.html_url}`;
     }
+
+    let foundAsanaTasks = [];
+    while ((parseAsanaURL = REGEX.exec(PULL_REQUEST.body)) !== null) {
+      let taskId = parseAsanaURL.groups.task;
+      if (taskId) {
+        foundAsanaLink = true;
+        asanaOperations(ASANA_PAT, targets, taskId, taskComment);
+        foundAsanaTasks.push(taskId);
+      } else {
+        core.error(`Invalid Asana task URL after the trigger phrase ${TRIGGER_PHRASE}`);
+      }
+    }
+
+    const statusState = (!LINK_REQUIRED || foundAsanaTasks.length > 0) ? 'success' : 'error';
+    core.info(`setting ${statusState} for ${github.context.payload.pull_request.head.sha}`);
+    octokit.repos.createStatus({
+      ...github.context.repo,
+      'context': 'asana-link-presence',
+      'state': statusState,
+      'description': 'asana link not found',
+      'sha': github.context.payload.pull_request.head.sha,
+    });
+  } catch (error) {
+    core.setFailed(error.message);
   }
-} catch (error) {
-  core.error(error.message);
 }
+
+run()