{"_id":"@axis-backstage-staging/plugin-jira-dashboard","_rev":"1-0ce2973c92320ad2ac389ab1cff5a5c5","name":"@axis-backstage-staging/plugin-jira-dashboard","dist-tags":{"latest":"0.7.4"},"versions":{"0.7.3":{"name":"@axis-backstage-staging/plugin-jira-dashboard","version":"0.7.3","main":"src/index.ts","types":"src/index.ts","license":"Apache-2.0","publishConfig":{"access":"public","main":"dist/index.esm.js","types":"dist/index.d.ts"},"backstage":{"role":"frontend-plugin"},"sideEffects":false,"scripts":{"start":"backstage-cli package start","build":"backstage-cli package build","lint":"backstage-cli package lint","test":"backstage-cli package test","clean":"backstage-cli package clean","prepack":"backstage-cli package prepack","postpack":"backstage-cli package postpack"},"dependencies":{"@axis-backstage-staging/plugin-jira-dashboard-common":"workspace:^","@backstage/catalog-model":"^1.4.3","@backstage/core-components":"^0.13.10","@backstage/core-plugin-api":"^1.8.2","@backstage/errors":"^1.2.3","@backstage/plugin-catalog-react":"^1.9.3","@backstage/theme":"^0.5.0","@mui/material":"^5.15.7","@mui/styles":"^5.15.7","lodash":"^4.17.21","react-use":"^17.2.4"},"peerDependencies":{"@emotion/react":"^11.11.3","@emotion/styled":"^11.11.0","react":"^17.0.0  || ^18.0.0"},"devDependencies":{"@backstage/cli":"^0.25.1","@backstage/core-app-api":"^1.11.3","@backstage/dev-utils":"^1.0.26","@backstage/plugin-catalog-react":"^1.9.3","@backstage/test-utils":"^1.4.7","@testing-library/jest-dom":"6.0.0","@testing-library/react":"^14.0.0","@testing-library/user-event":"^14.0.0","msw":"^1.0.0"},"_id":"@axis-backstage-staging/plugin-jira-dashboard@0.7.3","gitHead":"cc32eb925bac4c544aa398d29e0edced640c3264","description":"Welcome to the Jira Dashboard plugin!","_nodeVersion":"18.18.0","_npmVersion":"9.8.1","dist":{"integrity":"sha512-fi3TLO5GZ04bwQgZi2/nIYmlooN01e6D50k3++z44yRKeHnwQv548dywY5xdwoTb1hlZh6wZTmb9UOyCZoZyMg==","shasum":"241eb351656a9e584d6eb4f45200a4828a58bc50","tarball":"https://registry.npmjs.org/@axis-backstage-staging/plugin-jira-dashboard/-/plugin-jira-dashboard-0.7.3.tgz","fileCount":9,"unpackedSize":45084,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCQurIUAmJX4bVnL2RR9ERYxyOMOAazFKIGN6RP/tmVMwIhAJH89StcTAqmcH8c+RcWigAOUurdtoOkxe314bQ/wecA"}]},"_npmUser":{"name":"glundh","email":"gustaf.lundh@axis.com"},"directories":{},"maintainers":[{"name":"glundh","email":"gustaf.lundh@axis.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/plugin-jira-dashboard_0.7.3_1711036856970_0.06377318138615573"},"_hasShrinkwrap":false},"0.7.4":{"name":"@axis-backstage-staging/plugin-jira-dashboard","version":"0.7.4","main":"dist/index.esm.js","types":"dist/index.d.ts","license":"Apache-2.0","publishConfig":{"access":"public","main":"dist/index.esm.js","types":"dist/index.d.ts","directory":"_release/package"},"backstage":{"role":"frontend-plugin"},"sideEffects":false,"scripts":{"start":"backstage-cli package start","build":"backstage-cli package build","lint":"backstage-cli package lint","test":"backstage-cli package test","clean":"backstage-cli package clean","prepack":"backstage-cli package prepack","postpack":"backstage-cli package postpack"},"dependencies":{"@axis-backstage-staging/plugin-jira-dashboard-common":"^0.4.0","@backstage/catalog-model":"^1.4.3","@backstage/core-components":"^0.13.10","@backstage/core-plugin-api":"^1.8.2","@backstage/errors":"^1.2.3","@backstage/plugin-catalog-react":"^1.9.3","@backstage/theme":"^0.5.0","@mui/material":"^5.15.7","@mui/styles":"^5.15.7","lodash":"^4.17.21","react-use":"^17.2.4"},"peerDependencies":{"@emotion/react":"^11.11.3","@emotion/styled":"^11.11.0","react":"^17.0.0  || ^18.0.0"},"devDependencies":{"@backstage/cli":"^0.25.1","@backstage/core-app-api":"^1.11.3","@backstage/dev-utils":"^1.0.26","@backstage/plugin-catalog-react":"^1.9.3","@backstage/test-utils":"^1.4.7","@testing-library/jest-dom":"6.0.0","@testing-library/react":"^14.0.0","@testing-library/user-event":"^14.0.0","msw":"^1.0.0"},"module":"./dist/index.esm.js","directory":"_release/package","_id":"@axis-backstage-staging/plugin-jira-dashboard@0.7.4","gitHead":"cc32eb925bac4c544aa398d29e0edced640c3264","description":"Welcome to the Jira Dashboard plugin!","_nodeVersion":"18.18.0","_npmVersion":"9.8.1","dist":{"integrity":"sha512-WVqWEsRzfP5xjVebnfGKJLXD5DqCYo1lbTWWXoH8Zc5jyCNzADUYQBJGX2JDEPOjOdGc5H3IipGCtDWZ5+/bUg==","shasum":"2e92d8ce40588f1f1d75bccba1555bd157ca4293","tarball":"https://registry.npmjs.org/@axis-backstage-staging/plugin-jira-dashboard/-/plugin-jira-dashboard-0.7.4.tgz","fileCount":9,"unpackedSize":45151,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC8AoPU9FurAbJn00CLKXSmd0somN5kWzQU29yJRw+46gIhALGl056Hp5ru1QJR4tQ0rKxoHD6rL9u8z5nKE/UiWFW2"}]},"_npmUser":{"name":"glundh","email":"gustaf.lundh@axis.com"},"directories":{},"maintainers":[{"name":"glundh","email":"gustaf.lundh@axis.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/plugin-jira-dashboard_0.7.4_1711040441762_0.23883941124336405"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-21T16:00:56.839Z","0.7.3":"2024-03-21T16:00:57.134Z","modified":"2024-03-21T17:00:42.595Z","0.7.4":"2024-03-21T17:00:41.945Z"},"maintainers":[{"name":"glundh","email":"gustaf.lundh@axis.com"}],"description":"Welcome to the Jira Dashboard plugin!","license":"Apache-2.0","readme":"# Jira Dashboard plugin\n\nWelcome to the Jira Dashboard plugin!\n\n![project-card](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/media/project-card.png)\n\n## Introduction\n\nThe **Jira Dashboard** plugin allows you to fetch and display Jira issues for your entity. You get quickly access to issue summaries to achieve better task visibility and more efficient project management. The issue overview that is provided can be customized to display the information that is relevant for your entity, by defining Jira filters and components.\n\nThis plugin supports both **Jira Software** and **Jira Cloud**.\n\nBy default, the issue views that are provided are **incoming issues**, **open issues** and **assigned to you**.\n\n## Jira Dashboard backend\n\nYou **need** to set up the [Jira Dashboard Backend](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard-backend) plugin before you move forward with any of these steps if you haven't already.\n\n## Getting Started\n\n1. First, install the plugin into your app:\n\n```bash\n# From your Backstage root directory\nyarn --cwd packages/app add @axis-backstage/plugin-jira-dashboard\n```\n\n2. Then, modify your entity page in `EntityPage.tsx` to include the `EntityJiraDashboardContent` component and the `isJiraDashboardAvailable` function. Both are exported from the plugin. The example below show how you can add the plugin to the `defaultEntityPage`:\n\n```tsx\n// In packages/app/src/components/catalog/EntityPage.tsx\nimport { EntityJiraDashboardContent, isJiraDashboardAvailable } from '@axis-backstage/plugin-jira-dashboard';\n\nconst defaultEntityPage = (\n  <EntityLayout.Route\n    if={isJiraDashboardAvailable}\n    path=\"/jira-dashboard\"\n    title=\"Jira Dashboard\"\n  >\n    <EntityJiraDashboardContent />\n  </EntityLayout.Route>\n  ...\n);\n```\n\nOPTIONAL: The function `isJiraDashboardAvailable` checks for the annotation `jira.com`. You can choose to check for another annotation by passing the prop `annotationPrefix` into the function. See example below.\n\n```tsx\n// In packages/app/src/components/catalog/EntityPage.tsx\nimport { EntityJiraDashboardContent, isJiraDashboardAvailable } from '@axis-backstage/plugin-jira-dashboard';\n\nconst defaultEntityPage = (\n  <EntityLayout.Route\n    if={entity => isJiraDashboardAvailable(entity, 'jira')}\n    path=\"/jira-dashboard\"\n    title=\"Jira Dashboard\"\n  >\n    <EntityJiraDashboardContent />\n  </EntityLayout.Route>\n  ...\n);\n```\n\n### Integration with the Catalog\n\nTo enable the Jira Dashboard plugin for your entity, the entity yaml must have the following annotation:\n\n```yaml\napiVersion: backstage.io/v1alpha1\nkind: Component\nmetadata:\n  # ...\n  annotations:\n    jira.com/project-key: value # The key of the Jira project to track for this entity\n```\n\n### Optional annotations\n\nIf you want to track specific components or filters for your entity, you can add the optional annotations `components` and `filters-ids`. You can specify an endless number of Jira components or filters.\n\n```yaml\napiVersion: backstage.io/v1alpha1\nkind: Component\nmetadata:\n  # ...\n  annotations:\n    jira.com/project-key: value # The key of the Jira project to track for this entity\n    jira.com/components: component,component,component # Jira component name separated with a comma. The Roadie Backstage Jira Plugin Jira annotation `/component` is also supported here by default\n    jira.com/filter-ids: 12345,67890 # Jira filter id separated with a comma\n```\n\n## Layout\n\nThe issue overview is located under the tab \"Jira Dashboard\" on the entity page. The overview displays information about the specific Jira project, and then renders one table for each type of issue view. In each view you can see the priority, assignee and status for that issue.\n\n![overview](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/media/overview.png)\n","readmeFilename":"README.md"}