{"id":19967386,"url":"https://github.com/teamstarter/jira-standard-version-release-check","last_synced_at":"2025-05-04T00:31:43.265Z","repository":{"id":63312411,"uuid":"562798957","full_name":"teamstarter/jira-standard-version-release-check","owner":"teamstarter","description":"A small tool to easily check if commits related to a User Story and their task is ready to be released in production.","archived":false,"fork":false,"pushed_at":"2023-07-25T14:46:04.000Z","size":1259,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-15T19:45:52.586Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teamstarter.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":"2022-11-07T09:31:03.000Z","updated_at":"2023-02-14T13:08:35.000Z","dependencies_parsed_at":"2024-11-13T06:03:11.080Z","dependency_job_id":null,"html_url":"https://github.com/teamstarter/jira-standard-version-release-check","commit_stats":{"total_commits":65,"total_committers":4,"mean_commits":16.25,"dds":0.0461538461538461,"last_synced_commit":"a459ebd7bb7a85f5fd8fd8017767b425bd34f8db"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamstarter%2Fjira-standard-version-release-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamstarter%2Fjira-standard-version-release-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamstarter%2Fjira-standard-version-release-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamstarter%2Fjira-standard-version-release-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teamstarter","download_url":"https://codeload.github.com/teamstarter/jira-standard-version-release-check/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252272944,"owners_count":21721831,"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-11-13T02:41:25.553Z","updated_at":"2025-05-04T00:31:42.690Z","avatar_url":"https://github.com/teamstarter.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Illustration tab](assets/check-release.gif)\n# jira-standard-version-release-check\n\nA small tool to easily check if commits related to a User Story and their task is ready to be released in production for a scrum project.\n## What can I do with check-release ?\n\nThe tools provided by this library will allow you to:\n\n- Compare your commits titles to your Jira US status in order to quickly see if the US are done and reviewed\n- Compare your commits titles to your Jira tasks status in order to quickly see if the tasks are done and reviewed\n\n## Getting started\n\nAdd the lib and the peer dependencies:\n\n```\n$ yarn add @teamstarter/jira-standard-version-release-check\n```\n\n⚠️ Caution: check-release requires at least Node v9.11.2 or greater as it is using async/await.\n\n### Setting up for versioning\n\nCheck-release uses [standard-version](https://www.npmjs.com/package/standard-version) to generate a changelog based on your commits.\n\n- You need to have a \"version\" field in your package.json.\n- Follow the [Conventional Commits Specification](http://www.conventionalcommits.org) in your repository.\n\n### Setting up .env file\n\nYou need to add the following entries in your env or in a .env file located in the current folder. \nFor all of the 'STATUS' in the env variable, you can set many of them, the script will compare env entries with US/tasks status with `includes()`. They are case insensitive.\n⚠️ Caution: the Jira API uses the language set in the Jira app. Be mindful of that when setting the following Jira status values.\n\n```\nJIRA_ACCOUNT_TOKEN=\nJIRA_ACCOUNT_EMAIL=\nJIRA_US_READY_TO_RELEASE_STATUS=\nJIRA_US_RELEASE_STATUS=\nJIRA_TASK_READY_TO_RELEASE_STATUS=\nJIRA_TASK_RELEASE_STATUS=\nJIRA_SUBDOMAIN=\nJIRA_PROJECT_KEY=\nCONFIG_SUBTASKS=\"true\"\n```\n\n- `JIRA_ACCOUNT_TOKEN` is the token you have to [generate on your atlassian profile](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token).\n- `JIRA_US_READY_TO_RELEASE_STATUS` is the status on Jira that you consider is \"ready to release\" for US.\n- `JIRA_US_RELEASE_STATUS` is the status on Jira that you consider is \"released\" for US.\n- `JIRA_TASK_READY_TO_RELEASE_STATUS` is the status on Jira that you consider is \"ready to release\" for tasks.\n- `JIRA_TASK_RELEASE_STATUS` is the status on Jira that you consider is \"released\" for task.\n- `JIRA_SUBDOMAIN` is the subdomain name of your organization when you connect on Jira (like so `\u003cJIRA_SUBDOMAIN\u003e.atlassian.net`).\n- `JIRA_PROJECT_KEY` is the project key on Jira (which is typically the shorthand version of the project's name).\n- `CONFIG_SUBTASKS=\"true\"` change to false if your project doesn't use subtasks.\n\n### Setting up your git commits\n\nMake sure that the commits must contain the US id, like so : `\u003cproject-key\u003e-\u003cUS number\u003e`\n\n## How to use\n\nYou can run the library with the cli command: `check-release`\n\n### Available options\n\nYou can apply the following options :\n\n```\n--onlyWarnings or -w : will only show warnings.\n--table or -t : will display output as a table (see console.table())\n--disableChecks or -d : will only display standard-version output without comparing it to Jira.\n```\n\nYou can combine onlyWarnings mode with table mode.\n\n## Understand the output\n\n### Error types\n\nYou might encounter the following errors:\n\n    - [🚨 MISSING US NB] =\u003e Your commit does not contain a correct US number, refer to the section about Setting up your git commits\n    - [🔥 ERROR DURING FETCH] =\u003e The fetch to the Jira API returned an error.\n    - [❓ WRONG US NB] =\u003e Your commit contains a US number that does not exists.\n\n### Status types for US\n\n    - 🚀 =\u003e US status = JIRA_US_RELEASE_STATUS.\n    - ✅ =\u003e US status = JIRA_US_READY_TO_RELEASE_STATUS.\n    - ❌ =\u003e US status isn't any of the above.\n\n### Status types for tasks\n\n    - 👌 =\u003e task status = JIRA_TASK_RELEASE_STATUS.\n    - ✅ =\u003e task status = JIRA_TASK_READY_TO_RELEASE_STATUS.\n    - 👎 =\u003e task status isn't any of the above.\n\n### Output formatting\n\n\nAll possible outputs:\n![All possible output](assets/normal.png)\nTable output: \n![Tab output](assets/table.png)\n```\n[\u003cUS STATUS EMOJI\u003e \u003cUS STATUS (if not in prod)\u003e] @\u003cASSIGNEE (if is not ready)\u003e \u003cUS TITLE\u003e]\n\u003c List of tasks (if not in prod):\n(\u003ctask status emoji\u003e \u003ctask title\u003e @\u003cassignee (if is not ready)\u003e \u003ctask key\u003e)\n\u003e\n\u003cLink to US (if ready)\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamstarter%2Fjira-standard-version-release-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamstarter%2Fjira-standard-version-release-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamstarter%2Fjira-standard-version-release-check/lists"}