Skip to content

References to <username>@users.noreply.github.com should be reworked, as they are misleading#27985

Closed
@jsoref

Description

@jsoref

馃憠 To the contributor who picks up this issue: See the content plan to follow below, under the header "Maintainer note."

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll

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

There are several references to <username>@users.noreply.github.com email addresses in the docs:

https://github.com/search?q=repo%3Agithub%2Fdocs+%3Cusername%3E%40&type=code

This is slightly misleading. The correct behaviour is described in a note on "Setting your commit email address":

Note: If you created your account on GitHub.com after July 18, 2017, your noreply email address for GitHub is an ID number and your username in the form of ID+USERNAME@users.noreply.github.com. If you created your account on GitHub.com prior to July 18, 2017, and enabled Keep my email address private prior to that date, your noreply email address from GitHub is USERNAME@users.noreply.github.com. You can get an ID-based noreply email address for GitHub by selecting (or deselecting and reselecting) Keep my email address private in your email settings.

Additional information

I made the mistake of relying on this (or equivalent) documentation and then people told me I was doing it wrong...

You can see all the times I did it wrong in:
https://github.com/search?q=%22jsoref%40users.noreply.github.com%22+%2F%5B%5E%2B%5Djsoref%40users.noreply.github.com%2F&type=code
And you can see that I'm not the only one who made that mistake if you adjust the query a bit.

You can see more recent things where I'm doing it "right":
https://github.com/search?q=%222119212%2Bjsoref%40users.noreply.github.com%22&type=pullrequests
https://github.com/search?q=%222119212%2Bjsoref%40users.noreply.github.com%22&type=code

Here's a commit
https://github.com/check-spelling/check-spelling-docs/commit/0643ed1315fc1df51858307573a4f123d494df29.patch generated by using the web editor -- https://github.com/check-spelling/check-spelling/wiki/_compare/86e0773ecf7ad1c138ee8a01a9499118ec7301a9...0643ed1315fc1df51858307573a4f123d494df29

Maintainer note

Where references to <username>@users.noreply.github.com exist (see the search), we should change this language to be more general about a no-reply email address that will vary depending on when the username was changed, then link to the article https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.

For example:

... the commit author email address cannot be changed and is <username>@users.noreply.github.com by default

Might become:

... the commit author email address cannot be changed and will be a no-reply by default. For more information about the exact form the no-reply email address can take, see "AUTOTITLE."

Where AUTOTITLE is [AUTOTITLE](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) in the Markdown.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issuepagesContent related to GitHub Pagespumpkin-spiceSpecifically tracked Hacktoberfest issue - internal purposes

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions