Skip to content
This repository has been archived by the owner on May 20, 2024. It is now read-only.

Add automated final comment to merged/closed docs PRs #1645

Closed
samccann opened this issue Mar 18, 2022 · 5 comments · Fixed by #1646
Closed

Add automated final comment to merged/closed docs PRs #1645

samccann opened this issue Mar 18, 2022 · 5 comments · Fixed by #1646

Comments

@samccann
Copy link
Contributor

To encourage contributors, we'd like to add the following comment after each docs PR is closed or merged:

Thanks for your Ansible docs contribution! We talk about Ansible documentation on maxtrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

@mkrizek
Copy link
Collaborator

mkrizek commented Mar 21, 2022

With the current implementation of the bot this is not possible because bot does not scan closed issues/PRs. However I suspect that with GraphQL we could query closed/merged PRs with docs_only label that were closed X hours ago and process them in order to add such a comment. I'd need to investigate it more and be fine with adding such functionality.

Also, there is a related issue in #1067 to mention Docs WG on docs issues/PRs. Is that something that would be effectively a duplicate of this?

Alternatively we could implement the above issue which would make the bot add such a comment on every new docs_only issue as opposed to after a PR is closed/merged which is how the current "working groups notifications" functionality works - although with collections it is not needed.

I am fine with either, let me know what you think.

@mkrizek
Copy link
Collaborator

mkrizek commented Mar 21, 2022

@samccann
Copy link
Contributor Author

I'm fine with it happening when the PR is opened for sure. Can we modify ^^ to mention the matrix channel as well?

mkrizek added a commit to mkrizek/ansibullbot that referenced this issue Mar 21, 2022
@mkrizek
Copy link
Collaborator

mkrizek commented Mar 21, 2022

@samccann I created #1646 that adds the proposed comment on every PR that has docs_only label. It means that every new PR that gets labeled docs_only will receive that comment but also all existing PRs already labeled docs_only will receive that comment. Also, any currently existing PR without that label will receive the comment once docs_only label is applied anytime in future.

Let me know if you want to change to newly created issues only; I wonder if that would be better, less noisy.

The PR closes #1067 and this issue.

@samccann
Copy link
Contributor Author

There are only about 24 docs-only PRs and I'm fine with the extra comment on each. Might shake loose some attention because a few have been lingering for a time.

Thanks for this!

mkrizek added a commit that referenced this issue Mar 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants