Skip to content

Commit

Permalink
remove placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
hectorsector committed Jan 22, 2024
1 parent 8423fee commit 0cc1af8
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 24 deletions.
1 change: 0 additions & 1 deletion .github/steps/1-removing-sensitive-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
The first step is always the hardest, so pick something easy!
Link to docs.github.com for further explanations.
Encourage users to open new tabs for steps!
TBD-step-1-notes.
-->

## Step 1: Removing sensitive data
Expand Down
1 change: 0 additions & 1 deletion .github/steps/2-removing-with-bfg.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
<<< Author notes: Step 2 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
TBD-step-2-notes.
-->

## Step 2: Removing a file from Git history using BFG Repo-Cleaner
Expand Down
1 change: 0 additions & 1 deletion .github/steps/3-avoiding-future-commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
<<< Author notes: Step 3 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
TBD-step-3-notes.
-->

## Step 3: Avoiding future commits with `.env`
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/0-welcome.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,3 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
from_step: 0
to_step: 1
branch_name: tbd-branch-name
9 changes: 3 additions & 6 deletions .github/workflows/1-removing-sensitive-data.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
name: Step 1, Removing sensitive data

# This step triggers after TBD-step-1-event-desc.
# This workflow updates from step 1 to step 2.

# This will run every time we TBD-step-1-event-desc.
# This will run every time we push a `.env` file.
# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
on:
workflow_dispatch:
# Add events that trigger this workflow.
# TBD-step-1-event:
push:
paths:
- .env
Expand All @@ -33,8 +31,8 @@ jobs:
outputs:
current_step: ${{ steps.get_step.outputs.current_step }}

on_TBD-step-1-event:
name: On TBD-step-1-event
on_push-dotenv-file:
name: On push of .env file
needs: get_current_step

# We will only run this action when:
Expand Down Expand Up @@ -74,4 +72,3 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
from_step: 1
to_step: 2
branch_name: tbd-branch-name
11 changes: 4 additions & 7 deletions .github/workflows/2-removing-with-bfg.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
name: Step 2, Removing a file with BFG Repo-Cleaner

# This step triggers after TBD-step-2-event-desc.
# This workflow updates from step 2 to step 3.

# This will run every time we TBD-step-2-event-desc.
# This will run every time we push to the repository.
# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
on:
workflow_dispatch:
# Add events that trigger this workflow.
# TBD-step-2-event:
push:

# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
Expand All @@ -31,8 +29,8 @@ jobs:
outputs:
current_step: ${{ steps.get_step.outputs.current_step }}

on_TBD-step-2-event:
name: On TBD-step-2-event
on_push:
name: On push
needs: get_current_step

# We will only run this action when:
Expand All @@ -54,7 +52,7 @@ jobs:
with:
fetch-depth: 0 # Let's get all the branches.

# TBD-step-2-additional-steps
# Logic for step 2
- name: Ensure .env is gone from history
run: |
if [ -n "$(git log --stat --all -- .env)" ]; then
Expand All @@ -72,4 +70,3 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
from_step: 2
to_step: 3
branch_name: tbd-branch-name
11 changes: 4 additions & 7 deletions .github/workflows/3-avoiding-future-commits.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
name: Step 3, Avoiding future commits with .env

# This step triggers after TBD-step-3-event-desc.
# This workflow updates from step 3 to step 4.

# This will run every time we TBD-step-3-event-desc.
# This will run every time we push `.gitignore`.
# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
on:
workflow_dispatch:
# Add events that trigger this workflow.
# TBD-step-3-event:
push:
paths:
- .gitignore
Expand All @@ -33,8 +31,8 @@ jobs:
outputs:
current_step: ${{ steps.get_step.outputs.current_step }}

on_TBD-step-3-event:
name: On TBD-step-3-event
on_push-gitignore:
name: On push of .gitignore
needs: get_current_step

# We will only run this action when:
Expand All @@ -56,7 +54,7 @@ jobs:
with:
fetch-depth: 0 # Let's get all the branches.

# TBD-step-3-additional-steps
# Logic for step 3
- name: Check if .gitignore contains .env
run: |
if grep -qw ".env" .gitignore; then
Expand All @@ -74,4 +72,3 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
from_step: 3
to_step: X
branch_name: tbd-branch-name

0 comments on commit 0cc1af8

Please sign in to comment.