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

Pre-receive hooks/$GITHUB_VIA #1082

Closed
blastedt opened this issue Nov 4, 2020 · 7 comments
Closed

Pre-receive hooks/$GITHUB_VIA #1082

blastedt opened this issue Nov 4, 2020 · 7 comments
Assignees
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@blastedt
Copy link

blastedt commented Nov 4, 2020

What article on docs.github.com is affected?

https://github.com/github/docs/blob/main/content/admin/policies/creating-a-pre-receive-hook-script.md

What part(s) of the article would you like to see updated?

The environment variable $GITHUB_VIA has a list of possible values.

  1. This list needs an explanation of the meaning of each value (ex: slumlord, stafftools, etc are unclear)
  2. This list needs to be updated to be current. For example, editing a file in Github's editor gives the value blob#save which isn't listed in the table at all.
  3. This list needs to make clear that remote pushes (end user running git push in their local terminal) will not have $GITHUB_VIA set, and to list what other situations this variable will not be set.

Additional information

I would make this change myself but I honestly am having trouble determining the intended behavior! A docs update would be a great help to me.

@welcome
Copy link

welcome bot commented Nov 4, 2020

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 4, 2020
@blastedt
Copy link
Author

blastedt commented Nov 5, 2020

Sorry, not sure how to respond to that! Could you let me know what you need more clearly please?

Edit: The weird image-only comment got deleted. Leaving this here so that context doesn't get destroyed.

@janiceilene
Copy link
Contributor

The welcome bot comment is just intended to let you know that we'll look at your issue soon, no response necessary!

Thank so much for letting us know about this @blastedt! I'll have some folks internally take a look at this and see what updates we might be able to make 💛 In the meantime, I'll add a help wanted label and maybe someone out there will have some ideas to address your concerns 🤞

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team core help wanted Anyone is welcome to open a pull request to fix this issue labels Nov 6, 2020
@blastedt
Copy link
Author

blastedt commented Nov 6, 2020

Thanks Janice, I appreciate it. Tim

@guaxy94

This comment has been minimized.

@blastedt
Copy link
Author

Hey Matt, thanks for closing this out! The docs look super helpful now. Tim

@mattpollard
Copy link
Contributor

👋🏻 Thanks for creating this issue, @blastedt 🙏🏻 And thanks for your patience while I did some research and prioritized the changes. Let us know if you see any further opportunities to improve this or other documentation 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

No branches or pull requests

6 participants
@mattpollard @blastedt @janiceilene @guaxy94 and others