Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Jira Dashboard plugin #19901

Closed
wants to merge 66 commits into from
Closed

Add Jira Dashboard plugin #19901

wants to merge 66 commits into from

Conversation

fridajac
Copy link
Contributor

@fridajac fridajac commented Sep 12, 2023

Hey, I just made a Pull Request!

This PR adds the Jira Dashboard plugin. The plugin is a Jira issue overview that can be added as a page in the EntityPage overview tabs. The issue view displays issue summaries to help achieve better task visibility and more efficient project management.

project-card

Information that this plugin provides:

  • The Jira project that is relevant for that entity, with information about the project name, key, category, description, project lead, and avatar.
  • Jira issues and their type, key, summary, status, and assignee.
  • By default, the issue views that are provided are incoming issues, open issues and assigned to you. You can also customise the view to display the information relevant for your entity by defining Jira filters and components.

issue-card

overview

Isn’t there already a Jira plugin?

Yes, Roadie is one of the main Backstage contributors and offers the Backstage Jira plugin. This plugin also provides information from Jira, such as project and project type.

However, Roadie’s Backstage Jira plugin focuses on exposing the quantity of different issue types and the project activity stream. The new Jira Dashboard plugin in this PR takes a different approach, displaying issues in tables. In addition, the Jira Dashboard plugin provides the possibility of linking not only a Jira project, but also specific Jira components and filters to your entities.

Changes:

  • Backend: Added the Jira Dashboard backend plugin
  • Frontend: Added the Jira Dashboard frontend plugin

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

Frida Jacobsson and others added 26 commits September 8, 2023 09:00
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented Sep 12, 2023

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

  • @backstage/plugin-jira-dashboard-backend
  • @backstage/plugin-jira-dashboard-common

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name Package Path Changeset Bump Current Version
example-app packages/app none v0.2.88-next.0
example-backend-next packages/backend-next none v0.0.16-next.0
example-backend packages/backend none v0.2.88-next.0
@backstage/plugin-jira-dashboard-backend plugins/jira-dashboard-backend none v0.0.0
@backstage/plugin-jira-dashboard-common plugins/jira-dashboard-common none v0.0.0
@backstage/plugin-jira-dashboard plugins/jira-dashboard minor v0.0.0

Frida Jacobsson added 3 commits September 13, 2023 11:19
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
fridajac and others added 3 commits September 18, 2023 18:53
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Copy link
Collaborator

@awanlin awanlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for following up on my previous comments, this is looking really solid now @fridajac 🚀

I left one comment around ownership in the catalog-info.yaml files and related CODEOWNERS file

Frida Jacobsson and others added 3 commits September 21, 2023 14:15
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridahelenajacobsson@gmail.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Copy link
Collaborator

@awanlin awanlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just going to say this again but awesome work @fridajac, approving based on my review 🚀

@fridajac
Copy link
Contributor Author

Just going to say this again but awesome work @fridajac, approving based on my review 🚀

Thank you! And thanks for all your help and feedback :)

Copy link
Member

@freben freben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fantastic work! Really only the codeowners command and secret marker that are important, the rest is more informative and can be skipped if you want to soldier through.

Thanks also @awanlin for all your help!

.github/CODEOWNERS Outdated Show resolved Hide resolved
plugins/jira-dashboard/src/hooks/useJira.ts Show resolved Hide resolved
plugins/jira-dashboard/README.md Outdated Show resolved Hide resolved
plugins/jira-dashboard-common/src/annotations.ts Outdated Show resolved Hide resolved
plugins/jira-dashboard-common/src/annotations.ts Outdated Show resolved Hide resolved
plugins/jira-dashboard-backend/config.d.ts Show resolved Hide resolved
plugins/jira-dashboard-backend/config.d.ts Show resolved Hide resolved
plugins/jira-dashboard-backend/src/service/router.ts Outdated Show resolved Hide resolved
Frida Jacobsson and others added 9 commits September 26, 2023 13:59
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridahelenajacobsson@gmail.com>
Signed-off-by: Frida Jacobsson <fridahelenajacobsson@gmail.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
Signed-off-by: Frida Jacobsson <fridaja@axis.com>
@GLundh
Copy link
Contributor

GLundh commented Oct 3, 2023

@freben : Is this blocked by #20266?

@freben
Copy link
Member

freben commented Oct 3, 2023

Not in the sense that the RFC is what's been holding it back until now - I'm just slowly working through some reviews. But thanks for bringing it up though, because it became top of mind as late as today actually. Might as well start the discussion. Is there some possibility of having this entire plugin maintained off-repo? It'd bring significant benefits in terms of being unblocked from our review loop, if nothing else.

Since this is so far gone and ready, and you gut unfortunately stranded mid-RFC, I could perhaps consider merging this and then awaiting the processing of moving it out later on. But it'd of course lead to churn where you would probably have to deprecate this particular package on the @backstage prefix, and replacing it with a new one.

@fridajac
Copy link
Contributor Author

fridajac commented Oct 4, 2023

We had a discussion yesterday and decided that yes, since we will have to move out this plugin later anyway, we might just publish the plugin off-repo from the start. So I'll close this pull request. Thank you for all your help and comments @freben @awanlin @vinnie-jog-on, very appreciated, really made the plugin better :)

@fridajac fridajac closed this Oct 4, 2023
@freben
Copy link
Member

freben commented Oct 4, 2023

Awesome, thanks for your patience in this. Hopefully the reviews were useful in the mean time! And of course, we're more than happy to surface your work in the plugin list etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants