Merge pull request #2 from atlassian/merge-old-repo

Merge old repo

.github/main.workflow

@@ -45,7 +45,7 @@ action "Jira Transition" {
 }
 
 action "Jira Find" {
-  uses = "./actions/find"
+  uses = "./actions/find-issue-key"
   needs = ["Jira Transition"]
-  args = "GA-2"
+  args = "GA-1"
 }

README.md

@@ -1,11 +1,45 @@
 # GitHub Actions for Jira
-The GitHub Actions for [Jira](https://www.atlassian.com/software/jira) to create and edit Jira issues
+
+The GitHub Actions for [Jira](https://www.atlassian.com/software/jira) to create and edit Jira issues. 
+In the [demo-gajira](https://github.com/atlassian/gajira-demo) repository you'll find examples of what you can do with these actions, in particular:
+
+- Automatically transition an issue to done when a pull request whose name contains the issue key is merged
+- Automatically create a new Jira issue when a GitHub issue is created
+- Automatically add a comment to a Jira issue when a commit message contains the issue key
+- Automatically create a Jira issue for each `// TODO:` in code
 
 ## Actions
- - [`Login`](./actions/login) - Stores credentials from environment variables
- - [`CLI`](./actions/cli) - Wrapped [go-jira](https://github.com/Netflix-Skunkworks/go-jira) CLI
- - [`Create`](./actions/create) - Create new Jira issue
- - [`Transition`](./actions/transition) - Transition an issue
- - [`Find`](./actions/find) - Find an issue to operate
- - [`Comment`](./actions/comment) - Add a comment to an issue
- - [`TODO`](./actions/todo) - Create Jira issue for TODO comments
+
+- [`Login`](./actions/login) - Log in to the Jira API
+- [`CLI`](./actions/cli) - Wrapped [go-jira](https://github.com/Netflix-Skunkworks/go-jira) CLI for common Jira actions
+- [`Find issue key`](./actions/find-issue-key) - Search for an issue key in commit message, branch name, etc. This issue key is then saved and used by the next actions in the same workflow
+- [`Create`](./actions/create) - Create a new Jira issue
+- [`Transition`](./actions/transition) - Transition a Jira issue
+- [`Comment`](./actions/comment) - Add a comment to a Jira issue
+- [`TODO`](./actions/todo) - Create a Jira issue for each TODO comment in committed code
+
+Each action supports command line parameters (e.g. `--from=branch`) and lodash (e.g. `{{event.ref}}` which is its equivalent) as input.
+
+## Usage
+An example workflow to create a Jira issue for each `//TODO` in code:
+
+```
+workflow "Todo issue" {
+  on = "push"
+  resolves = ["Jira Login"]
+}
+
+action "Jira Login" {
+  uses = "atlassian/gajira/actions/login@master"
+  secrets = ["JIRA_BASE_URL", "JIRA_API_TOKEN", "JIRA_USER_EMAIL"]
+}
+
+action "Jira TODO" {
+  needs = "Jira Login"
+  uses = "atlassian/gajira/actions/todo@master"
+  secrets = ["GITHUB_TOKEN"]
+  args = "--project=GA --issuetype=Task"
+}
+```
+
+More examples at [gajira-demo](https://github.com/atlassian/gajira-demo) repository 

actions/find/README.md → actions/find-issue-key/README.md

@@ -1,4 +1,4 @@
-# Jira Find
+# Jira Find Issue Key
 Extract issue key from string
 
 ## Usage

actions/find/action.js → actions/find-issue-key/action.js

@@ -4,8 +4,8 @@ const Jira = require('./common/net/Jira')
 const issueIdRegEx = /([a-zA-Z0-9]+-[0-9]+)/g
 
 const eventTemplates = {
-  'branch': "{{event.ref}}",
-  'commits': "{{event.commits.map(c=>c.message).join(' ')}}",
+  branch: '{{event.ref}}',
+  commits: "{{event.commits.map(c=>c.message).join(' ')}}",
 }
 
 module.exports = class {

actions/find/common/net/Jira.js → actions/find-issue-key/common/net/Jira.js

@@ -21,13 +21,15 @@ class Jira {
     const { fields = [], expand = [] } = query
 
     try {
-      return this.fetch('getIssue', {
+      const res = await this.fetch('getIssue', {
         pathname: `/rest/api/2/issue/${issueId}`,
         query: {
           fields: fields.join(','),
           expand: expand.join(','),
         },
       })
+
+      return res
     } catch (error) {
       if (get(error, 'res.status') === 404) {
         return

actions/todo/README.md

@@ -18,7 +18,7 @@ Single-line comments in these formats:
 ## Action Spec:
 
 ### Environment variables
-- GITHUB_TOKEN
+- `GITHUB_TOKEN` - GitHub secret [token](https://developer.github.com/actions/creating-workflows/storing-secrets/#github-token-secret) is used to retrieve diffs 
 
 ### Arguments