-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1428 from SEKOIA-IO/update-automation-library-doc…
…umentation Refresh automation library documentation
- Loading branch information
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Atlassian JIRA | ||
|
||
![Atlassian JIRA](/assets/playbooks/library/atlassian-jira.png){ align=right width=150 } | ||
|
||
Integrates with JIRA | ||
|
||
## Configuration | ||
|
||
| Name | Type | Description | | ||
| --------- | ------- | --------------------------- | | ||
| `domain` | `string` | Your organization JIRA domain (e.g. 'sandbox.atlassian.net') | | ||
| `email` | `string` | Email of the user | | ||
| `api_key` | `string` | API Key to use to connect to JIRA API endpoints | | ||
|
||
## Actions | ||
|
||
### Change Status of an Issue | ||
|
||
Change status of an issue in JIRA | ||
|
||
**Arguments** | ||
|
||
| Name | Type | Description | | ||
| --------- | ------- | --------------------------- | | ||
| `issue_key` | `string` | Issue key (e.g. PROJ-1) | | ||
| `status_name` | `string` | Exact name of the status (e.g. 'To Do') | | ||
|
||
### Comment Issue | ||
|
||
Add comment to an issue in JIRA | ||
|
||
**Arguments** | ||
|
||
| Name | Type | Description | | ||
| --------- | ------- | --------------------------- | | ||
| `issue_key` | `string` | Issue key (e.g. PROJ-1) | | ||
| `comment` | `string` | Text of a comment | | ||
|
||
### Create Issue | ||
|
||
Create issue in JIRA | ||
|
||
**Arguments** | ||
|
||
| Name | Type | Description | | ||
| --------- | ------- | --------------------------- | | ||
| `project_key` | `string` | Project key (e.g. 'PRJ') | | ||
| `summary` | `string` | Summary of an issue (e.g. 'Fix a bug') | | ||
| `issue_type` | `string` | Issue type (e.g. 'Task') | | ||
| `due_date` | `string` | Due date (e.g. '2023-10-31')' | | ||
| `labels` | `string` | Comma-separated labels (e.g. 'devops,support') | | ||
| `assignee` | `string` | Exact display name of an assignee (e.g. John Doe) | | ||
| `reporter` | `string` | Exact display name of a reporter (e.g. Jane Doe) | | ||
| `priority` | `string` | Issue priority (e.g. Highest) | | ||
| `parent_key` | `string` | Key of a parent issue (e.g. PRJ-1) | | ||
|
||
|
||
**Outputs** | ||
|
||
| Name | Type | Description | | ||
| --------- | ------- | --------------------------- | | ||
| `issue_key` | `string` | Key of the created issue | | ||
|
||
|
||
## Extra | ||
|
||
Module **`Atlassian JIRA` v1.0.4** |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters