{"id":22973915,"url":"https://github.com/frieder/jira-issue-info","last_synced_at":"2025-08-13T14:33:26.532Z","repository":{"id":143303403,"uuid":"609319854","full_name":"frieder/jira-issue-info","owner":"frieder","description":"A Github action to pull properties from a Jira issue and make it available to other steps via output","archived":false,"fork":false,"pushed_at":"2024-11-19T13:52:21.000Z","size":450,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-19T14:52:37.352Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frieder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-03T21:18:59.000Z","updated_at":"2024-11-19T13:52:25.000Z","dependencies_parsed_at":"2024-02-22T14:47:42.745Z","dependency_job_id":"a7e0cd25-b891-409c-ba9b-7f1c8cbc63f7","html_url":"https://github.com/frieder/jira-issue-info","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frieder%2Fjira-issue-info","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frieder%2Fjira-issue-info/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frieder%2Fjira-issue-info/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frieder%2Fjira-issue-info/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frieder","download_url":"https://codeload.github.com/frieder/jira-issue-info/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229767231,"owners_count":18121043,"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-12-14T23:59:33.323Z","updated_at":"2024-12-14T23:59:33.903Z","avatar_url":"https://github.com/frieder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jira Issue Info - Github Action\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/frieder/jira-issue-info/pr.yml?label=Build%20Status)](https://github.com/frieder/jira-issue-info/actions/workflows/pr.yml)\n[![Open Issues](https://img.shields.io/github/issues-raw/frieder/jira-issue-info?label=Open%20Issues)](https://github.com/frieder/jira-issue-info/issues?q=is%3Aopen+is%3Aissue)\n[![Sonar Issues](https://img.shields.io/sonar/violations/frieder_jira-issue-info/main?format=long\u0026server=https%3A%2F%2Fsonarcloud.io\u0026label=Sonar%20Violations)](https://sonarcloud.io/project/overview?id=frieder_jira-issue-info)\n[![Known Vulnerabilities](https://snyk.io/test/github/frieder/jira-issue-info/badge.svg)](https://snyk.io/test/github/frieder/jira-issue-info)\n\nA GitHub action to update properties of an existing Jira issue.\n\n\u003e -   Only supports Jira Cloud.\n\u003e -   Requires [Jira Login Action](https://github.com/marketplace/actions/atlassian-jira-login).\n\n## Usage\n\n```yaml\nname: Get Jira Issue Properties\n\non: [..]\n\njobs:\n  jira-issue-info:\n    name: Jira Issue Info\n    runs-on: ubuntu-latest\n    steps:\n      - name: Jira Login\n        uses: frieder/gha-jira-login@v1\n        env:\n          JIRA_BASE_URL: ${{ vars.JIRA_BASE_URL }}\n          JIRA_USER_EMAIL: ${{ vars.JIRA_USER_EMAIL }}\n          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}\n\n      - name: Get Issue Properties\n        id: issue\n        uses: frieder/jira-issue-info@v1\n        with:\n          retries: 1 # optional\n          retryDelay: 10 # optional\n          timeout: 2000 # optional\n          issue: WEB-123\n          customFields: |\n            previousStatus: 10858\n            transitionStatus: 10859\n\n      - name: Print Output\n        run: |\n          echo \"Issue = ${{ steps.issue.outputs.issue }}\"\n          echo \"Summary = ${{ steps.issue.outputs.summary }}\"\n          echo \"Description = ${{ steps.issue.outputs.description }}\"\n          echo \"Type = ${{ steps.issue.outputs.type }}\"\n          echo \"Type ID = ${{ steps.issue.outputs.typeID }}\"\n          echo \"Status = ${{ steps.issue.outputs.status }}\"\n          echo \"Status ID = ${{ steps.issue.outputs.statusID }}\"\n          echo \"Priority = ${{ steps.issue.outputs.priority }}\"\n          echo \"Priority ID = ${{ steps.issue.outputs.priorityID }}\"\n          echo \"Labels = ${{ steps.issue.outputs.labels }}\"\n          echo \"Reporter Name = ${{ steps.issue.outputs.reporter }}\"\n          echo \"Reporter ID = ${{ steps.issue.outputs.reporterID }}\"\n          echo \"Assignee Name = ${{ steps.issue.outputs.assignee }}\"\n          echo \"Assignee ID = ${{ steps.issue.outputs.assigneeID }}\"\n          echo \"Components = ${{ steps.issue.outputs.components }}\"\n          echo \"Previous Status = ${{ steps.issue.outputs.previousStatus }}\"\n          echo \"Transition Status = ${{ steps.issue.outputs.transitionStatus }}\"\n          echo 'JSON = ${{ steps.issue.outputs.json }}'\n\n      - name: Issue status is \"To Do\"\n        if: steps.issue.outputs.status == 'To Do'\n        run: echo \"Ticket is in 'To Do'\"\n\n      - name: Issue status is \"In Progress\"\n        if: steps.issue.outputs.status == 'In Progress'\n        run: echo \"Ticket is 'In Progress'\"\n```\n\n## Configuration Options\n\n### Option: retries\n\n|          |     |\n| :------- | :-- |\n| Required | no  |\n| Default  | 1   |\n\nThis option allows to define a number of retries when the HTTP call to the Jira REST API fails (e.g. due to\nconnectivity issues). By default, the action will attempt one retry and after that report the action as failed.\n\n### Option: retryDelay\n\n|          |     |\n| :------- | :-- |\n| Required | no  |\n| Default  | 10  |\n\nIn case the `retries` option is \u003e 0, this option defines the time (in seconds) that the action will wait\nbefore it sends another request.\n\n### Option: timeout\n\n|          |      |\n| :------- | :--- |\n| Required | no   |\n| Default  | 2000 |\n\nThe time (in milliseconds) the action will wait for a request to finish. If the request does not finish in\ntime it will be considered failed.\n\n### Option: issue\n\n|          |     |\n| :------- | :-- |\n| Required | yes |\n| Default  |     |\n\nThe ID of the Jira ticket (e.g. XYZ-123).\n\n### Option: customFields\n\n|          |    |\n| :------- |:---|\n| Required | no |\n| Default  |    |\n\nA multiline string of custom fields that defines which values should be made available as output.\nThe format is `\u003coutput name\u003e: \u003cfield ID\u003e`. The field ID defines the number of the custom field \nin Jira. The output name is the name used to register the custom field's value as output.\n\n# Response Output\n\nThe action will provide the following outputs:\n\n- `issue`: The issue key (e.g. XYZ-123).\n- `summary`: The summary of the issue.\n- `description`: The description of the issue.\n- `type`: The type of the issue.\n- `typeID`: The ID of the type of the issue.\n- `status`: The status of the issue.\n- `statusID`: The ID of the status of the issue.\n- `priority`: The priority of the issue.\n- `priorityID`: The ID of the priority of the issue.\n- `labels`: The labels of the issue.\n- `reporter`: The name of the reporter of the issue.\n- `reporterID`: The ID of the reporter of the issue.\n- `assignee`: The name of the assignee of the issue.\n- `assigneeID`: The ID of the assignee of the issue.\n- `components`: The components of the issue.\n- `json`: The JSON response of the Jira REST API.\n\n## Test Action\n\nThis action can be tested during development with the use of https://github.com/nektos/act.\n\nPlease adapt the values accordingly, both in the workflow file and in the CLI command.\n\n```\nact -W .github/workflows/pr.yml \\\n    -j check \\\n    -s JIRA_URL=*** \\\n    -s JIRA_EMAIL=*** \\\n    -s JIRA_TOKEN=***\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrieder%2Fjira-issue-info","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrieder%2Fjira-issue-info","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrieder%2Fjira-issue-info/lists"}