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

Enable Support for Multiple Jira Project Keys #233

Merged
merged 3 commits into from
Jan 16, 2025

Conversation

SaachiNayyer
Copy link
Contributor

Hey, I just made a Pull Request!

This enhancement would be highly beneficial for users managing multiple Jira projects associated with a single entity

Context

This PR supports both single and multiple project keys. It ensures that the function can handle an array of project keys and constructs the JQL query accordingly.

Issue ticket number and link

#232

  • Fixes # (issue)

Checklist before requesting a review

  • I have performed a self-review of my own code
  • I have verified that the code builds perfectly fine on my local system
  • I have verified that my code follows the style already available in the repository
  • 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)

@SaachiNayyer SaachiNayyer requested a review from a team as a code owner December 13, 2024 14:30
Copy link

changeset-bot bot commented Dec 13, 2024

🦋 Changeset detected

Latest commit: 0472085

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@axis-backstage/plugin-jira-dashboard-backend Minor
backend Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@fridajac fridajac left a comment

Choose a reason for hiding this comment

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

Can you also update the README.md in jira-dashboard to show the user how to use multiple projects?

Copy link
Contributor

@fridajac fridajac left a comment

Choose a reason for hiding this comment

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

There seems to be an error when I add the optional annotation jira.com/incoming-issues-status: (https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/README.md#optional-annotations). If the submitted status, for instance Incoming, doesn't exist in the project, an error is thrown.
Screenshot from 2025-01-08 16-49-24

@SaachiNayyer
Copy link
Contributor Author

There seems to be an error when I add the optional annotation jira.com/incoming-issues-status: (https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/README.md#optional-annotations). If the submitted status, for instance Incoming, doesn't exist in the project, an error is thrown. Screenshot from 2025-01-08 16-49-24
Hi @fridajac
Thank you for pointing this out. I’d like to clarify my understanding to ensure we're aligned:
The jira.com/incoming-issues-status annotation should work based on the provided status and project keys. From my perspective, if a valid status is specified and corresponds to an available status in the specified Jira project(s), the query should execute correctly. If the status is not valid or doesn't exist in the specified projects, Jira should return an empty response, not throw an error.
Could you please confirm if this issue is directly related to the recent change for supporting multiple project keys? If so, any additional details or scenarios where this error occurs would help me investigate further.

@SaachiNayyer
Copy link
Contributor Author

Can you also update the README.md in jira-dashboard to show the user how to use multiple projects?

Done

@fridajac
Copy link
Contributor

There seems to be an error when I add the optional annotation jira.com/incoming-issues-status: (https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/README.md#optional-annotations). If the submitted status, for instance Incoming, doesn't exist in the project, an error is thrown. Screenshot from 2025-01-08 16-49-24
Hi @fridajac
Thank you for pointing this out. I’d like to clarify my understanding to ensure we're aligned:
The jira.com/incoming-issues-status annotation should work based on the provided status and project keys. From my perspective, if a valid status is specified and corresponds to an available status in the specified Jira project(s), the query should execute correctly. If the status is not valid or doesn't exist in the specified projects, Jira should return an empty response, not throw an error.
Could you please confirm if this issue is directly related to the recent change for supporting multiple project keys? If so, any additional details or scenarios where this error occurs would help me investigate further.

Sure! I'll have a look at it this afternoon and get back to you 🙂

@fridajac
Copy link
Contributor

There seems to be an error when I add the optional annotation jira.com/incoming-issues-status: (https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/README.md#optional-annotations). If the submitted status, for instance Incoming, doesn't exist in the project, an error is thrown. Screenshot from 2025-01-08 16-49-24
Hi @fridajac
Thank you for pointing this out. I’d like to clarify my understanding to ensure we're aligned:
The jira.com/incoming-issues-status annotation should work based on the provided status and project keys. From my perspective, if a valid status is specified and corresponds to an available status in the specified Jira project(s), the query should execute correctly. If the status is not valid or doesn't exist in the specified projects, Jira should return an empty response, not throw an error.
Could you please confirm if this issue is directly related to the recent change for supporting multiple project keys? If so, any additional details or scenarios where this error occurs would help me investigate further.

Sure! I'll have a look at it this afternoon and get back to you 🙂

I added a comment on the specific line that is causing problems :) And yes, the backend should return an empty response, not throw an error.

@SaachiNayyer
Copy link
Contributor Author

There seems to be an error when I add the optional annotation jira.com/incoming-issues-status: (https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/jira-dashboard/README.md#optional-annotations). If the submitted status, for instance Incoming, doesn't exist in the project, an error is thrown. Screenshot from 2025-01-08 16-49-24
Hi @fridajac
Thank you for pointing this out. I’d like to clarify my understanding to ensure we're aligned:
The jira.com/incoming-issues-status annotation should work based on the provided status and project keys. From my perspective, if a valid status is specified and corresponds to an available status in the specified Jira project(s), the query should execute correctly. If the status is not valid or doesn't exist in the specified projects, Jira should return an empty response, not throw an error.
Could you please confirm if this issue is directly related to the recent change for supporting multiple project keys? If so, any additional details or scenarios where this error occurs would help me investigate further.

Sure! I'll have a look at it this afternoon and get back to you 🙂

I added a comment on the specific line that is causing problems :) And yes, the backend should return an empty response, not throw an error.

Thanks @fridajac, I have made the changes :)

@fridajac
Copy link
Contributor

Hi again @SaachiNayyer! Please have a look at the formatting errors, and then I'll take a closer look at the PR again :)

Copy link
Contributor

@fridajac fridajac left a comment

Choose a reason for hiding this comment

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

Great job! Thanks for this contribution, it's really nice. 💯

@fridajac fridajac merged commit 3f9ac75 into AxisCommunications:main Jan 16, 2025
3 checks passed
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.

2 participants