Skip to content

Commit 252ba05

Browse files
committed
Update step content ot address feedback
1 parent 0cc1af8 commit 252ba05

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

.github/steps/1-removing-sensitive-data.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ See [Deleting a file on GitHub Docs](https://docs.github.com/en/repositories/wor
2020

2121
### :keyboard: Activity: Remove `.env` in the project root directory
2222

23-
1. Open your terminal of choice and clone this repository.
23+
1. Open your terminal of choice, clone this repository, and switch to your repository directory.
2424
```shell
2525
git clone <your-repository-url>
26+
cd <your-repository-name>
2627
```
2728
2. Delete `.env` from the root directory.
2829
```shell

.github/steps/2-removing-with-bfg.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ _You removed `.env` from the repository's root directory! :tada:_
1010

1111
Now that we've deleted the file, people that browse the repository on GitHub.com or anyone looking at just the head commit won't see the file. However, due to Git's nature, the file is still present in the history. In this step, we'll work on removing the file from the repository history.
1212

13-
**What is a _head commit_**?: In Git, HEAD points to a branch or a commit. When we say [head commit](https://docs.github.com/en/get-started/quickstart/github-glossary#head), we usually mean the most recent commit in the repository's history.
13+
**What is a _head commit_**? In Git, HEAD points to a branch or a commit. When we say [head commit](https://docs.github.com/en/get-started/quickstart/github-glossary#head), we usually mean the most recent commit in the repository's history.
1414

1515
There are multiple tools available for removing Git history, we'll use BFG Repo-Cleaner in this step. You can find additional documentation on [Using the BFG in GitHub Docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository#using-the-bfg).
1616

17-
**What is _BFG Repo-Cleaner_**?: BFG Repo-Cleaner is software that can help you search through and alter repository history. Git can natively do this using [`git filter-repo`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository#using-git-filter-repo), but it can be more complex.
17+
**What is _BFG Repo-Cleaner_**? BFG Repo-Cleaner is software that can help you search through and alter repository history. Git can natively do this using [`git filter-repo`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository#using-git-filter-repo), but it can be more complex.
1818

1919
### :keyboard: Activity: Use BFG Repo-Cleaner to remove the `.env` file
2020

@@ -36,7 +36,7 @@ There are multiple tools available for removing Git history, we'll use BFG Repo-
3636
bfg --delete-files .env
3737
```
3838
6. The tool will run and make some suggestions about some follow-up commands. Run those to get your local repository cleaned up.
39-
7. Repeat the sarch for .env in the repository's history. This time, the command should return empty.
39+
7. Repeat the search for `.env` in the repository's history. This time, the command should return empty.
4040
```shell
4141
git log --stat --all -- .env
4242
```

.github/steps/3-avoiding-future-commits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The steps we've taken so far ensure that any _new_ clones of the repository don'
1212

1313
Now that we've mitigated the risk of exposing sensitive content, we'll be proactive and prevent its addition.
1414

15-
We'll now configure Git so it ignores a future addition of sensitive content by adding the filename to `.gitignore`. If someone should add it to the local copy of their repository, it will remain only on the contributor's machine and won't be pushed to GitHub.
15+
We'll now configure Git so it ignores a future addition of sensitive content by adding `.env` to `.gitignore`. If someone should that file to the local copy of their repository, it will remain only on the contributor's machine and won't be pushed to GitHub.
1616

1717
**What is `.gitignore`?** This special file allows us to tell Git naming patterns to ignore. You can read more about it in [Ignoring files on GitHub Docs](https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files).
1818

0 commit comments

Comments
 (0)