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

Clarify "removing secrets from previous commits" section #35235

Merged
merged 3 commits into from
Nov 11, 2024

Conversation

lacymorrow
Copy link
Contributor

Why:

I've run into this issue multiple times.

In the sections to "Removing a secret introduced by...", following the steps as described will not do anything. Git is used by folks who are not get experts, therefore we should describe each step fully.

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.

Copy link

welcome bot commented Nov 8, 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 Nov 8, 2024
Copy link
Contributor

github-actions bot commented Nov 8, 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
code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.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

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team code security Content related to code security waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 8, 2024
gtothe7

This comment was marked as spam.

mchammer01
mchammer01 previously approved these changes Nov 11, 2024
Copy link
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lacymorrow - thanks so much for spotting these inaccuracies and omissions ✨
Made a minor change to do with wording that I am going to apply.

…ning-and-push-protection/working-with-push-protection-from-the-command-line.md
Copy link
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :shipit:

@mchammer01 mchammer01 added this pull request to the merge queue Nov 11, 2024
Merged via the queue into github:main with commit 6db4207 Nov 11, 2024
46 checks passed
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@lacymorrow
Copy link
Contributor Author

Thanks folks! I ran into the issue again today 😅

@mchammer01
Copy link
Contributor

What do you mean @lacymorrow? Your updates are in the docs. Do these need further tweaking?

@nguyenalex836
Copy link
Contributor

I think @lacymorrow was expressing gratitude for the update to the docs, as she ran into a scenario again where clarity on these steps helped her 💛 But let me know if I am off!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code security Content related to code security 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.

4 participants