init

Author: drudzikatlassian

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+    "extends": "@atlassian-partner-engineering",
+    "rules": {
+      "no-plusplus": "off"
+    }
+  }
+  

Dockerfile

@@ -0,0 +1,20 @@
+FROM node:10-alpine
+
+LABEL "name"="Jira TODO"
+LABEL "maintainer"="Dima Rudzik <drudzik+githubactions@atlassian.net>"
+LABEL "version"="1.0.0"
+
+LABEL "com.github.actions.name"="Jira TODO"
+LABEL "com.github.actions.description"="Create Jira issue for TODO comments"
+LABEL "com.github.actions.icon"="check-square"
+LABEL "com.github.actions.color"="blue"
+
+RUN apk update && apk add --no-cache ca-certificates
+
+ADD https://github.com/atlassian/gajira/raw/master/bin/gagas .
+ADD . .
+RUN npm i
+RUN chmod +x /entrypoint.sh
+RUN chmod +x /gagas
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -0,0 +1,26 @@
+# Jira TODO
+Create issue for TODO comments
+
+## Usage
+
+Create Jira issue from TODO comments in pushed code.
+
+Single-line comments in these formats:
+
+```go
+// TODO: refactor this callback mess
+```
+```ruby
+# TODO: rewrite api client
+```
+
+----
+## Action Spec:
+
+### Environment variables
+- `GITHUB_TOKEN` - GitHub secret [token](https://developer.github.com/actions/creating-workflows/storing-secrets/#github-token-secret) is used to retrieve diffs 
+
+### Arguments
+
+- `--project=<project key>` - Key of the project
+- `--issuetype=<issue type>` - Type of the issue to be created. Example: 'Task'

action.js

@@ -0,0 +1,143 @@
+const _ = require('lodash')
+const fetch = require('node-fetch')
+const Jira = require('./common/net/Jira')
+const GitHub = require('./common/net/GitHub')
+
+module.exports = class {
+  constructor ({ githubEvent, argv, config, githubToken }) {
+    this.Jira = new Jira({
+      baseUrl: config.baseUrl,
+      token: config.token,
+      email: config.email,
+    })
+
+    this.GitHub = new GitHub({
+      token: githubToken
+    })
+
+    this.config = config
+    this.argv = argv
+    this.githubEvent = githubEvent
+    this.githubToken = githubToken
+  }
+
+  async execute () {
+    const { argv, githubEvent } = this
+    const projectKey = argv.project
+    const issuetypeName = argv.issuetype
+    let tasks = []
+
+    if (githubEvent.commits && githubEvent.commits.length > 0) {
+      tasks = _.flatten(await this.findTodoInCommits(githubEvent.repository, githubEvent.commits))
+    }
+
+    if (tasks.length === 0) {
+      console.log('no TODO found')
+
+      return
+    }
+
+    // map custom fields
+    const { projects } = await this.Jira.getCreateMeta({
+      expand: 'projects.issuetypes.fields',
+      projectKeys: projectKey,
+      issuetypeNames: issuetypeName,
+    })
+
+    if (projects.length === 0) {
+      console.error(`project '${projectKey}' not found`)
+
+      return
+    }
+
+    const [project] = projects
+
+    if (project.issuetypes.length === 0) {
+      console.error(`issuetype '${issuetypeName}' not found`)
+
+      return
+    }
+
+    const issues = tasks.map(async ({ summary, commitUrl }) => {
+      let providedFields = [{
+        key: 'project',
+        value: {
+          key: projectKey,
+        },
+      }, {
+        key: 'issuetype',
+        value: {
+          name: issuetypeName,
+        },
+      }, {
+        key: 'summary',
+        value: summary,
+      }]
+
+      if (!argv.description) {
+        argv.description = `Created with GitHub commit ${commitUrl}`
+      }
+
+      providedFields.push({
+        key: 'description',
+        value: argv.description,
+      })
+
+      if (argv.fields) {
+        providedFields = [...providedFields, ...this.transformFields(argv.fields)]
+      }
+
+      const payload = providedFields.reduce((acc, field) => {
+        acc.fields[field.key] = field.value
+
+        return acc
+      }, {
+        fields: {},
+      })
+
+      return (await this.Jira.createIssue(payload)).key
+    })
+
+    return { issues: await Promise.all(issues) }
+  }
+
+  transformFields (fields) {
+    return Object.keys(fields).map(fieldKey => ({
+      key: fieldKey,
+      value: fields[fieldKey],
+    }))
+  }
+
+  preprocessArgs () {
+    _.templateSettings.interpolate = /{{([\s\S]+?)}}/g
+    const descriptionTmpl = _.template(this.argv.description)
+
+    this.argv.description = descriptionTmpl({ event: this.githubEvent })
+  }
+
+  async findTodoInCommits(repo, commits) {
+    return Promise.all(commits.map(async (c) => {
+      const res = await this.GitHub.getCommitDiff(repo.full_name, c.id)
+      const rx = /^\+.*(?:\/\/|#)\s+TODO:(.*)$/gm
+      return getMatches(res, rx, 1)
+        .map(_.trim)
+        .filter(Boolean)
+        .map((s) => {
+          return {
+            commitUrl: c.url,
+            summary: s,
+          }
+        })
+    }))
+  }
+}
+
+function getMatches(string, regex, index) {
+  index || (index = 1)
+  var matches = []
+  var match
+  while (match = regex.exec(string)) {
+    matches.push(match[index])
+  }
+  return matches
+}

common/net/GitHub.js

@@ -0,0 +1,80 @@
+const { get } = require('lodash')
+
+const serviceName = 'github'
+const { format } = require('url')
+const client = require('./client')(serviceName)
+
+class GitHub {
+  constructor ({token }) {
+    this.baseUrl = 'https://api.github.com'
+    this.token = token
+  }
+
+  async getCommitDiff (repo, commitId) {
+    return this.fetch('getCommitDiff', 
+      { pathname: `/repos/${repo}/commits/${commitId}`}, 
+      {
+        headers: {
+          Accept: 'application/vnd.github.v3.diff',
+        }
+      })
+  }
+
+  async fetch (apiMethodName,
+    { host, pathname, query },
+    { method, body, headers = {} } = {}) {
+    const url = format({
+      host: host || this.baseUrl,
+      pathname,
+      query,
+    })
+
+    if (!method) {
+      method = 'GET'
+    }
+
+    if (headers['Content-Type'] === undefined) {
+      headers['Content-Type'] = 'application/json'
+    }
+
+    if (headers.Authorization === undefined) {
+      headers.Authorization = `token ${this.token}`
+    }
+
+    // strong check for undefined
+    // cause body variable can be 'false' boolean value
+    if (body && headers['Content-Type'] === 'application/json') {
+      body = JSON.stringify(body)
+    }
+
+    const state = {
+      req: {
+        method,
+        headers,
+        body,
+        url,
+      },
+    }
+
+    try {
+      await client(state, `${serviceName}:${apiMethodName}`)
+    } catch (error) {
+      const fields = {
+        originError: error,
+        source: 'github',
+      }
+
+      delete state.req.headers
+
+      throw Object.assign(
+        new Error('GitHub API error'),
+        state,
+        fields,
+      )
+    }
+
+    return state.res.body
+  }
+}
+
+module.exports = GitHub