search

CircleCI-Public / jira-connect-orb

Display the status of CircleCI workflows and deployments in Jira!
https://circleci.com/orbs/registry/orb/circleci/jira
MIT License
25 stars 27 forks source link

Add ability to post deployment link #4

Closed michalochman closed 1 year ago

michalochman commented 5 years ago

Hi! Both build and deployment notifications work great, however I think it would be event better if it was possible to somehow let the orb know what is the URL to deployment. I'm gonna use your issue template for this feature request even thought it's more suited for bug reports 😉

Orb version

1.0.2

What happened

job_type: deployment links to CircleCI job, which makes more sense for build type:

Expected behavior

It would be great if job_type: deplyoment additionally linked to actual release (quick mockup):

I am not sure what is the best way to approach this, but it could be parameter that we use with the orb, like the environment_type or maybe there's an easier way like setting an environment variable.

eddiewebb commented 5 years ago

Hi @michalochman, thanks for sharing the suggestion! The orb's interaction is limited by the API exposed in Jira - https://developer.atlassian.com/cloud/jira/software/rest/#api-rest-deployments-0-1-bulk-post, and we don't have influence on rendering of the data.

To my interpretation it really only leaves us the Description and Display Name to provide this, but neither would be linkable like the job Url is.

I think it's worth sharing the feedback with Jira's Product team though, you can add a new suggestion here, https://jira.atlassian.com/secure/CreateIssue!default.jspa (I didn't find any matches existing)

Edit: I'm actually now realizing I am not clear what you mean by 'inked to actual release' - what is example.com/release/42 in your example (actual running app, artifact repo, etc)?

I'm just thinking we could make the general URL overridable if there is something better than the CircleCI Job url.

michalochman commented 5 years ago

Hi @eddiewebb, by "actual release" I meant both "actual running app" and "artifact repo" – in generic scenario the deployment doesn't have to be an app, it may be an artifact as well.

In the example looks like the API suggests deployments[X].url field for that:

"url": "http://mydeployer.com/project1/1111-222-333/prod-east",

Is it what you use to link the "#42 awesome_repo - deploy" text from my first screenshot back to CircleCI job?

I think that your idea to make the URL overridable might work, the default can be what you use now.

eddiewebb commented 5 years ago

Exactly. The payload has 2 URLs, one represents the "pipeline" which is the whole project in CircleCI terminology, and the 2nd URL represents the deployment itself, which is documented to be the specific job, but I'm not sure why that couldn't be left to the preference of each user.

KyleTryon commented 1 year ago

Hello Friends 👋

The day has finally come 🎉 ! As we have alluded to in a few spots in this repository, we have been working on a new integration for Jira with CircleCI to replace this outdated orb which has historically been difficult for us to update. Today we are excited to announce Jira Integration V2 is finally LIVE!

New Docs: https://circleci.com/docs/jira-plugin/ Orb v2:

Atlassian Forge App: https://github.com/CircleCI-Public/circleci-for-jira

Key Features

What to know