Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
drudzikatlassian committed Feb 27, 2019
1 parent 61a7d83 commit 7687f79
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,38 @@
# Jira Login
Used to store credentials for later use by [other actions](https://github.com/atlassian/gajira)
Used to store credentials for later use by other [Jira Actions](https://github.com/atlassian/gajira)

This is required by other actions like:
- [`Transition`](https://github.com/marketplace/actions/jira-transition) - Transition a Jira issue
- [`Comment`](https://github.com/marketplace/actions/jira-comment) - Add a comment to a Jira issue
- [`Create`](https://github.com/marketplace/actions/jira-create) - Create a new Jira issue
- [`Find issue key`](https://github.com/marketplace/actions/jira-find) - 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
- [`TODO`](https://github.com/marketplace/actions/jira-todo) - Create a Jira issue for each TODO comment in committed code
- [`CLI`](https://github.com/marketplace/actions/jira-cli) - Wrapped [go-jira](https://github.com/Netflix-Skunkworks/go-jira) CLI for common Jira actions

## 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-login@v1.0.0"
secrets = ["JIRA_BASE_URL", "JIRA_USER_EMAIL", "JIRA_API_TOKEN"]
uses = "atlassian/gajira-login@master"
secrets = ["JIRA_BASE_URL", "JIRA_API_TOKEN", "JIRA_USER_EMAIL"]
}
action "Jira TODO" {
needs = "Jira Login"
uses = "atlassian/gajira-todo@master"
secrets = ["GITHUB_TOKEN"]
args = "--project=GA --issuetype=Task"
}
```

More examples at [gajira-demo](https://github.com/atlassian/gajira-demo) repository

----
## Action Spec:

Expand Down

0 comments on commit 7687f79

Please sign in to comment.