Skip to content

Add preparation steps for sensitive data removal #45027

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.

Sign up for GitHub

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

Open
liujiayi12 wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −1
Open

Add preparation steps for sensitive data removal #45027

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion ...eping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,18 @@ If the commit that introduced the sensitive data exists in any forks, it will co

Consider these limitations and challenges in your decision to rewrite your repository's history.

## Before you begin

Before rewriting your repository's history, prepare for the cleanup and coordinate with anyone who might be affected.

* Revoke or rotate any exposed secrets before you rewrite history. Rewriting history removes the secret from some locations, but it does not prevent anyone who already saw the secret from using it.
* Identify every path or text value that needs to be removed. If the sensitive data moved between files or changed names, include each path or value in your cleanup plan.
* Ask collaborators to pause work on affected branches until the cleanup is complete. New commits pushed during the cleanup can require you to repeat the process.
* Check whether branch protections, tags, pull requests, or forks still reference the commit that introduced the sensitive data. These references can prevent the data from being fully removed.

## Purging a file from your local repository's history using git-filter-repo

1. Install the latest release of [the `git-filter-repo` tool](https://github.com/newren/git-filter-repo). You need a version with the `--sensitive-data-removal` flag, meaning at least version 2.47. You can install `git-filter-repo` manually or by using a package manager. For example, to install the tool with HomeBrew, use the `brew install` command.
1. Install the latest release of [the `git-filter-repo` tool](https://github.com/newren/git-filter-repo). You need a version with the `--sensitive-data-removal` flag, meaning at least version 2.47. You can install `git-filter-repo` manually or by using a package manager. For example, to install the tool with Homebrew, use the `brew install` command.

```shell
brew install git-filter-repo
Expand Down
Loading