-
-
Notifications
You must be signed in to change notification settings - Fork 219
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
Clarify default author/user/email in readme #123
Comments
Thanks for the suggestions! Always love when people have ideas to improve the documentation.
Yeah, that line seems out of place in the README. It's an artefact from the earliest days of the Action. I will update the README shortly. I will update the README with some of your suggestions, but the name and email of the user of the commit is by default "GitHub Actions" and "actions@github.com". This is by design. When I developed this Action, I wanted to to make it clear to the "consumer" that the Action has been created by a bot and not by an actual human. |
The README has been updated in 021e855 and 7cec9ac. As mentioned, the current "feature" of setting different user and author stays for now. If you think the README can be improved or other things might be unclear, please reopen this issue, leave a comment or create a new issue. |
@stefanzweifel, can I ask a few questions regarding the commit author field:
When using the
Q1) Did you actually intend to change the commit author field by default? If so, it would be nice to have an option to leave the commit author field untouched) README states the following about the committed author filed: commit_author: Author <actions@github.com> # defaults to author of the commit that triggered the run Q2) This section only shows Q3) Can you clarify, what is meant by "defaults to author of the commit that triggered the run"? Because many options fall under this description (untouched, changed to To sum up, if a change in the commit author field by default is intended, I suggest making roughly the following change to the README: - commit_author: Author <actions@github.com> # defaults to author of the commit that triggered the run
+ commit_author: Author <actions@github.com> # defaults to "username <username@users.noreply.github.com>", where "username" belongs to the author of the commit that triggered the run |
@npanuhin More than happy to answer your questions.
It wasn't my intention, but in your described scenario, (There is a --reset-author option available for If you must use
More than happy to merge a pull request that improves the documentation around this and gives a good example. The default commit_author value is declared in action.yml, but I agree that this is a bit too hidden.
With "defaults to author of the commit that triggered the run" I tried to describe/explain, that the so called More information about the contexts are in the GitHub Actions docs: https://docs.github.com/en/actions/learn-github-actions/contexts I'm more than happy to merge a PR with your proposed changes to the README. |
Thank you very much for your quick response! I will extract the committed author and add it as a parameter for I opened a PR with the previously proposed change + your tip in the example section: #315 |
Some suggestions for the readme.
Currently, this is near the top:
Seems kinda weird to put that at the top. I recommend putting that info in the
Usage
section, since that's where all the other defaults are specified. Also I think the explanation of the defaults could be better.How about something like this:
Also, it seems like that maybe that's not currently how the default author settings work, but I think that's how they should work, so maybe I'll create a feature request for that.
The text was updated successfully, but these errors were encountered: