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

Document notifications.failure_comment.message #735

Merged

Conversation

lbarcziova
Copy link
Member

@lbarcziova lbarcziova commented Sep 12, 2023

Related to packit/packit-service#1911

Merge once in production.

@softwarefactory-project-zuul
Copy link
Contributor

docs/configuration/index.md Outdated Show resolved Hide resolved
Comment on lines +394 to +410
Same as for other keys, you can define this option at the top-level, applying it to all jobs, or configure it
on a job level, enabling you to have specific messages for each job or opt not to have a message for certain
jobs. By default, no message is posted on job failure.
Copy link
Member

Choose a reason for hiding this comment

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

Good point with the top-level/job-level reminder. People still don't know this.

docs/configuration/index.md Show resolved Hide resolved
@lbarcziova lbarcziova force-pushed the failure-comment-message branch from acff947 to 6cc4634 Compare September 12, 2023 11:47
@softwarefactory-project-zuul
Copy link
Contributor

softwarefactory-project-zuul bot added a commit to packit/packit-service that referenced this pull request Sep 13, 2023
Implement commenting on failure based on config

If there is the failure_comment_message defined in the config, notify users via comment on failure using the configured message. Comment only once per commit SHA and job (utilising check of previous identical Packit comment).
Fixes #1911
TODO:

 Update or write new documentation in packit/packit.dev. (packit/packit.dev#735)


RELEASE NOTES BEGIN
We have introduced a new configuration option notifications.failure_comment.message that enables notifying users on failure via a comment using the configured message.
RELEASE NOTES END

Reviewed-by: Laura Barcziová
Reviewed-by: František Lachman <[email protected]>
Reviewed-by: Martin Pitt
@lbarcziova lbarcziova marked this pull request as ready for review September 13, 2023 07:44
@martinpitt
Copy link
Contributor

The feature landed and was announced -- time to land this documentation as well? Thanks!

@lbarcziova
Copy link
Member Author

@martinpitt oh sure, thanks for reminding!

@lbarcziova lbarcziova force-pushed the failure-comment-message branch from 6cc4634 to 957ae8a Compare September 20, 2023 06:57
@lbarcziova lbarcziova added the mergeit When set, zuul wil gate and merge the PR. label Sep 20, 2023
@softwarefactory-project-zuul
Copy link
Contributor

@lbarcziova
Copy link
Member Author

regate

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).
https://softwarefactory-project.io/zuul/t/packit-service/buildset/4c70f88acca54a0db458ee08a49a65b4

✔️ pre-commit SUCCESS in 1m 06s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit 0d09fbc into packit:main Sep 20, 2023
@lbarcziova lbarcziova deleted the failure-comment-message branch September 20, 2023 07:23
@martinpitt
Copy link
Contributor

I see it in https://packit.dev/docs/configuration/#message now, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mergeit When set, zuul wil gate and merge the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants