tyankatsu0105 / pick-up-jira-ticket-id-action

Pick up Jura ticket ID Action

Pick up Jira ticket ID from commit comment and combine as PR's comment

Usage

name: Notification
on:
  pull_request:
    types:
      - opened
      - edited
      - synchronize

jobs:
  notification:
    name: Notification
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      # See release versions https://github.com/tyankatsu0105/pick-up-jira-ticket-id-action/releases
      - uses: tyankatsu0105/pick-up-jira-ticket-id-action@v0.1.0
        id: jira-subtasks
        with:
          JIRA_CLIENT_PROTOCOL: ${{ secrets.JIRA_CLIENT_PROTOCOL }}
          JIRA_CLIENT_HOST: ${{ secrets.JIRA_CLIENT_HOST }}
          JIRA_CLIENT_USERNAME: ${{ secrets.JIRA_CLIENT_USERNAME }}
          JIRA_CLIENT_PASSWORD: ${{ secrets.JIRA_CLIENT_PASSWORD }}
          JIRA_CLIENT_API_VERSION: ${{ secrets.JIRA_CLIENT_API_VERSION }}
          JIRA_CLIENT_STRICT_SSL: ${{ secrets.JIRA_CLIENT_STRICT_SSL }}
          JIRA_TICKET_KEYS: PUJTIA

      - name: Create PR Comment
        uses: marocchino/sticky-pull-request-comment@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          header: jira-info
          message: |
            ${{ steps.jira-subtasks.outputs.message }}

This action includes node-jira-client. So, this document may help you.

• JIRA_CLIENT_PROTOCOL
  • example... https
  • default https
• JIRA_CLIENT_HOST
  • example... tyankatsu-sample.atlassian.net
• JIRA_CLIENT_USERNAME
  • example... [e-mail]
• JIRA_CLIENT_PASSWORD
  • Generated token with Jira software settings
• JIRA_CLIENT_API_VERSION
  • example... 3
  • default 2
• JIRA_CLIENT_STRICT_SSL
  • example... true
  • default true
• JIRA_TICKET_KEYS
  • example... (FOO|BAR)

Development

Commit

npm run commit

Release

npm run release

1. Automecally generate PR with shipjs
2. If merged PR, push Git tag with GitHub Action(release.yml)
3. We can use uses: tyankatsu0105/pick-up-jira-ticket-id-action@vx.y.z 🎉

LICENSE

MIT