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

Adding a possibility to tag/mention team members in the bot comment #558

Closed
ayakalauova opened this issue Sep 5, 2021 · 13 comments
Closed
Labels
enhancement New feature or request Stale

Comments

@ayakalauova
Copy link

It would be cool if there was an opportunity to have a placeholder string (like "@author" or "@assignee") to be able to tag them in the comment section

@ayakalauova ayakalauova added the enhancement New feature or request label Sep 5, 2021
@mikkilevon
Copy link

Maybe add a config of enable-mention-of-assignees: true/false? This could be also added for author and PR reviewers. The mentions could be added after the comment.

@C0ZEN
Copy link
Contributor

C0ZEN commented Sep 8, 2021

@luketomlinson WDYT? You said you wish to reduce the number of new options, nevertheless meanwhile there are requests for more.
What is the long run plan?

@luketomlinson
Copy link
Collaborator

@C0ZEN I'm thinking through this. I think part of our issue is that we have essentially 3x the number of inputs for a default/pr/issue, so scrolling through the readme, it feels somewhat enormous and hard to understand. A thought (though it might be more confusing), is to have some kind of bit mask for options, like 1 for issues, 2 for PRs and 3 for both.

@luketomlinson
Copy link
Collaborator

@ayakalauova Do you have an example of how this might work? Are you wanting to put something like @author in the stale comment itself?

@C0ZEN
Copy link
Contributor

C0ZEN commented Sep 8, 2021

@luketomlinson improving the doc is something I have in the pipe as well since a long time and this is why I am no longer providing new PR; I wish to wait for the other that I opened then will take the time to provide those improvements; in particular the one that remove the “generic” options to only keep “issue” or “pr” options.

@C0ZEN
Copy link
Contributor

C0ZEN commented Sep 8, 2021

I think she would like to have “smarter” comments to ping the author.

@ayakalauova
Copy link
Author

@luketomlinson exactly, so that I can put smth like @author and the bot would tag this person

@mikkilevon
Copy link

I've been looking into this for a bit and the problems I see with it are

  1. Github API does not provide these for PR's when querying for Issues (In Github PRs are a type of Issue). That would mean another API call to get just open PRs and mash the results together.
  2. The templates cant use @ author or @ reviewer @ assignee as they are actual Github users. The template would need to be matched to something like {author} etc

Would this be a viable starting point?

@C0ZEN
Copy link
Contributor

C0ZEN commented Sep 16, 2021

@mikkilevon

The templates cant use @ author or @ reviewer @ assignee as they are actual Github users. The template would need to be matched to something like {author} etc

Definitely, the message template should differ and use a syntax different from GitHub to just replace the occurrences with the right information.

Github API does not provide these for PR's when querying for Issues (In Github PRs are a type of Issue). That would mean another API call to get just open PRs and mash the results together.

I think multiple API calls at the beginning of the workflow is OK but based on the initial feature request on this ticket which cover the original author and the assignees, the API already give this information when calling the endpoint, so I do not think you have to do a specific call.
See https://docs.github.com/en/rest/reference/issues

@mikkilevon
Copy link

mikkilevon commented Sep 16, 2021

Ah it does provide author and assignees but not reviewers as those would be also a good idea to mention 🤔 But yeah would be outside the scope of the initial feature request

@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

@github-actions github-actions bot added the Stale label Oct 17, 2021
@C0ZEN
Copy link
Contributor

C0ZEN commented Oct 17, 2021

up

@github-actions github-actions bot removed the Stale label Oct 18, 2021
@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Stale
Projects
None yet
Development

No branches or pull requests

4 participants