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

doc: modify the signing commit command #34831

Conversation

CodeLeom
Copy link

@CodeLeom CodeLeom commented Oct 4, 2024

Why:

The existing article instruct on how to sign a commit, but the provided command was wrong. I used the command, but it was not working until I was able to figure it out.

The existing command: git commit -S -m "YOUR_COMMIT_MESSAGE"

Correct command: git commit -s -m "YOUR_COMMIT_MESSAGE"

I also provided an additional context to why the signing might fail if the email on the local machine and remote (github) does not match.

Closes:

N/A

What's being changed (if available, include any code snippets, screenshots, or gifs):

command

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Signed-off-by: Aransiola Ayodele <36636824+CodeLeom@users.noreply.github.com>
Copy link

welcome bot commented Oct 4, 2024

Thanks for opening this pull request! 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 Oct 4, 2024
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
authentication/managing-commit-signature-verification/signing-commits.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

Signed-off-by: Aransiola Ayodele <36636824+CodeLeom@users.noreply.github.com>
Signed-off-by: Aransiola Ayodele <36636824+CodeLeom@users.noreply.github.com>
Signed-off-by: Aransiola Ayodele <36636824+CodeLeom@users.noreply.github.com>
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review authentication Content relating to authentication and removed triage Do not begin working on this issue until triaged by the team labels Oct 4, 2024
@nguyenalex836
Copy link
Contributor

@CodeLeom Thanks so much for opening a PR! I'll get this triaged for review ✨

@subatoi
Copy link
Contributor

subatoi commented Oct 7, 2024

Hello again 👋 and thanks for your submission—

This is another case where I'd recommend raising an issue first in future, so we can figure out the best way to help you. -s is actually a different option and it isn't relevant here. If -S was/is failing for you when trying to follow this flow, then that suggests something is misconfigured in your setup. I'm afraid we're not equipped to help with that in this repo, but if your plan includes GitHub Support, you can reach out to them for help https://docs.github.com/en/support/contacting-github-support. As far as the other changes are concerned, once again I'm not sure how much this will actually help other users, as this page already links to https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key

Thank you again for your interest in the GitHub Docs

@subatoi subatoi closed this Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants