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

Display more information about deployment based on description #1737

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

benoittgt
Copy link

As mentioned in Github documentation:

Deployment statuses can also include an optional description and log_url, which are highly recommended because they make deployment statuses more useful.

We want to avoid having duplicate information between "pipeline" and "deployments" and use the more rich informations provided on description.

d-11-10_à_15_11_10

For people who use the classic Github Action to mark deployment as suggested by Jira. It's here:

https://github.com/chrnorm/deployment-action/blob/880668c419e283adc6b1cc092d52eb5e558fec4d/action.yml#L24-L26

Related:

@benoittgt
Copy link
Author

For the test. This is pure guessing. I was not able to run the test locally.

@benoittgt benoittgt marked this pull request as ready for review November 10, 2022 17:25
@benoittgt benoittgt requested a review from a team as a code owner November 10, 2022 17:25
As mentioned in [Github documentation](https://docs.github.com/en/rest/deployments/deployments#about-the-deployments-api):
> Deployment statuses can also include an optional description and log_url, which are highly recommended because they make deployment statuses more useful.

We want to avoid having duplicate information between "pipeline" and
"deployments" and use the more rich informations provided on
description.

For people who use the classic Github Action to mark deployment as suggested by Jira. It's here:

https://github.com/chrnorm/deployment-action/blob/880668c419e283adc6b1cc092d52eb5e558fec4d/action.yml#L24-L26

Related:
  - atlassian#1536
  - atlassian#1732
  - atlassian#1736
Instead of having basic information at initial deploy, we should prefer
using Deployment Status description first.
Example, the deployment failed. We could provide informations about why
the deployment failed.
@rachellerathbone
Copy link
Contributor

@benoittgt there are several checks failing. Could you please resolve this and we can work on getting this merged.

@benoittgt
Copy link
Author

Sorry that's an old work. I didn't have time yet to look at it.

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

3 participants