Jira Login

Used to store credentials for later use by other Jira Actions

For examples on how to use this, check out the gajira-demo repository

Only supports Jira Cloud. Does not support Jira Server (hosted)

This is required by other actions like:

• Transition - Transition a Jira issue
• Comment - Add a comment to a Jira issue
• Create - Create a new Jira issue
• 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
• TODO - Create a Jira issue for each TODO comment in committed code
• CLI - Wrapped go-jira CLI for common Jira actions

Usage

An example workflow to create a Jira issue for each //TODO in code:

on: push

name: Jira Example

jobs:
  build:
    runs-on: ubuntu-latest
    name: Jira Example
    steps:
    - name: Login
      uses: atlassian/gajira-login@master
      env:
        JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
        JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
        JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

    - name: Jira TODO
      uses: atlassian/gajira-todo@master
      with:
        project: GA
        issuetype: Task
        description: Created automatically via GitHub Actions
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

More examples at gajira-demo repository

Action Spec:

Enviroment variables

• JIRA_BASE_URL - URL of Jira instance. Example: https://<yourdomain>.atlassian.net
• JIRA_API_TOKEN - Access Token for Authorization. Example: HXe8DGg1iJd2AopzyxkFB7F2 (How To)
• JIRA_USER_EMAIL - email of the user for which Access Token was created for . Example: [email protected]

Arguments

• None

Writes fields to config file at $HOME/jira/config.yml

• email - user email
• token - api token
• baseUrl - URL for Jira instance

Writes fields to CLI config file at $HOME/.jira.d/config.yml

• endpoint - URL for Jira instance
• login - user email

Writes env to file at $HOME/.jira.d/credentials

• JIRA_API_TOKEN - Jira API token to use with CLI