{"id":17793951,"url":"https://github.com/nora-soderlund/jira-summary-action","last_synced_at":"2025-04-02T02:20:32.261Z","repository":{"id":192899397,"uuid":"687566739","full_name":"nora-soderlund/jira-summary-action","owner":"nora-soderlund","description":"A GitHub Action that posts the summary of a linked Jira story in pull requests.","archived":false,"fork":false,"pushed_at":"2024-01-25T18:00:05.000Z","size":12175,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-26T09:00:57.040Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nora-soderlund.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-09-05T16:06:24.000Z","updated_at":"2024-03-21T20:14:15.000Z","dependencies_parsed_at":"2023-09-05T21:26:57.934Z","dependency_job_id":"21d973dc-2751-47da-89ad-107d5f345305","html_url":"https://github.com/nora-soderlund/jira-summary-action","commit_stats":null,"previous_names":["nora-soderlund/jira-summary-action"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nora-soderlund%2Fjira-summary-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nora-soderlund%2Fjira-summary-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nora-soderlund%2Fjira-summary-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nora-soderlund%2Fjira-summary-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nora-soderlund","download_url":"https://codeload.github.com/nora-soderlund/jira-summary-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246741283,"owners_count":20826098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-27T11:14:37.922Z","updated_at":"2025-04-02T02:20:32.227Z","avatar_url":"https://github.com/nora-soderlund.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jira-summary-action\nThis is a GitHub Action that allows you to fetch the summary and description of a story in Jira and comment it in a pull request, together with a link to the story. This is a tool to improve developer efficieny.\n\n![image](https://github.com/nora-soderlund/jira-summary-action/assets/78360666/f38e0d24-e8b0-43fa-a2e3-4e01aca0c9d5)\n\n## Getting started\nAdd the action to your pull request workflow, which searches for Jira story keys with the project key `ABC`:\n```yml\n  - name: Get summary from Jira\n    uses: nora-soderlund/jira-summary-action@v0.9.3\n    with:\n      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n      JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}\n      JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}\n      JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}\n      JIRA_KEY: ABC\n```\n\nAnd ensure the appropriate permissions are granted:\n```yml\n  permissions:\n    contents: read\n    pull-requests: write\n    issues: write\n```\n\n**Warning**, if you include a dash, e.g. `ABC-`, it will look for a story by that key as that would become a story key, or rather an invalid key.\n\n### Example\n```yml\non:\n  pull_request:\n    types: [ opened, reopened, edited ]\n\njobs:\n  run-jira-summary-action:\n    runs-on: ubuntu-latest\n    name: Get Jira story summary\n    permissions:\n      contents: read\n      pull-requests: write\n      issues: write\n\n    steps:\n      - name: Checkout the branch\n        uses: actions/checkout@v3\n      \n      - id: story\n        name: Get summary from Jira\n        uses: nora-soderlund/jira-summary-action@v0.9.3\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}\n          JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}\n          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}\n          JIRA_KEY: ABC\n      \n      - name: Print the title and description\n        run: echo \"The title is ${{ steps.story.outputs.title }} and the description is ${{ steps.story.outputs.description }}\"\n```\n\n## Reference\n### Inputs\n| Input | Type | Default | Description |\n| ----- | ---- | ------- | ----------- |\n| JIRA_BASE_URL (required) | String | - | The Jira base url |\n| JIRA_USER_EMAIL (required) | String | - | The Jira user email |\n| JIRA_API_TOKEN (required) | String | - | The Jira API token for the specified user email |\n| | | | |\n| GITHUB_TOKEN (required) | String | - | The GitHub Token to use, e.g. GITHUB_TOKEN |\n| | | | |\n| JIRA_KEY (required) | String | - | The project key prefix to look for - or the full story key. |\n| JIRA_KEY_MULTIPLE | Boolean | false | If true and JIRA_KEY is a project key, post a comment for every story key found. |\n| JIRA_PARTIAL_KEY_SILENT_FAILURE | Boolean | false | If true, not finding a story key in a pull request if a project key is specified, only throws a silent error. |\n| DISABLE_PULL_REQUEST_COMMENT | Boolean | false | If true, using the action will not create or update a pull request comment. Useful for only fetching the issue details from the output. |\n| IGNORE_BRANCHES | Regex | - | If source branch name mathces this regex ignore pull request. |\n\n### Outputs\n| Output | Type | Description |\n| ------ | ---- | ----------- |\n| key | String | Matched JIRA key. |\n| title | String | If JIRA_KEY_MULTIPLE is false, the title of the linked story. |\n| description | String | If JIRA_KEY_MULTIPLE is false, the description of the linked story in markdown. |\n\n## Permissions required\n| Permission | Access |\n| ---------- | ------ |\n| contents | read |\n| pull-requests | read |\n| issues | write |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnora-soderlund%2Fjira-summary-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnora-soderlund%2Fjira-summary-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnora-soderlund%2Fjira-summary-action/lists"}