1
0
mirror of https://github.com/tektoncd/catalog.git synced 2024-11-24 06:15:46 +00:00
catalog/task/jira-get-ticket-status/0.1/README.md
Juan Lozano 96c4ea272d Add jira-get-ticket-status task
Update jira-get-ticket-status.yaml

Add SHA instead of tag named

Changed secret name and now have a parameter to specify the value

Improve documentation

Improve documentation

Update api version and minimal pipeline compatible version

Fix trailing spaces on python code
2024-07-03 14:21:28 +01:00

58 lines
1.3 KiB
Markdown

# Jira - Get Ticket Status
This task helps you to get the current status of a Jira ticket.
## Install the Task
```
kubectl apply -f https://api.hub.tekton.dev/v1/resource/tekton/task/jira-get-ticket-status/0.1/raw
```
## Parameters
* **ticket_id:** Jira Ticket ID.
* **ssl_verify:** Verify or not SSL certificates (by default: `true`).
* **secret_name:** The name of the secret that have the Jira URL and the Bearer token.
## Results
* **ticket_status**: Current Jira Ticket status
## Platforms
The Task can be run on `linux/amd64` platform.
## Usage
This Task implements a `Secret`to provide the required **Bearer Token** to authenticate with Jira platform. For example:
```yaml
# Complete the fields indicated below
kind: Secret
apiVersion: v1
metadata:
name: jira-config
stringData:
JIRA_BEARER_TOKEN: #{BEARER_TOKEN}
JIRA_URL: #{JIRA_PLATFORM_URL}
type: Opaque
```
Then, to use it in a `Pipeline` only reference this Task properly:
```yaml
apiVersion: tekton.dev/v1beta1
kind: Pipeline
metadata:
name: example-jira-pipeline
spec:
tasks:
- name: verify-jira-ticket-status
taskRef:
name: jira-get-ticket-status
params:
- name: ticket_id
value: 'KAN-3'
- name: secret_name
value: jira-config
```