From 0cc1af8af42252079959b284ce2366c12c5f09e0 Mon Sep 17 00:00:00 2001 From: Hector Alfaro Date: Mon, 22 Jan 2024 09:50:19 -0500 Subject: [PATCH] remove placeholders --- .github/steps/1-removing-sensitive-data.md | 1 - .github/steps/2-removing-with-bfg.md | 1 - .github/steps/3-avoiding-future-commits.md | 1 - .github/workflows/0-welcome.yml | 1 - .github/workflows/1-removing-sensitive-data.yml | 9 +++------ .github/workflows/2-removing-with-bfg.yml | 11 ++++------- .github/workflows/3-avoiding-future-commits.yml | 11 ++++------- 7 files changed, 11 insertions(+), 24 deletions(-) diff --git a/.github/steps/1-removing-sensitive-data.md b/.github/steps/1-removing-sensitive-data.md index cc95aa7..a362729 100644 --- a/.github/steps/1-removing-sensitive-data.md +++ b/.github/steps/1-removing-sensitive-data.md @@ -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 diff --git a/.github/steps/2-removing-with-bfg.md b/.github/steps/2-removing-with-bfg.md index fc5bb3c..19a0415 100644 --- a/.github/steps/2-removing-with-bfg.md +++ b/.github/steps/2-removing-with-bfg.md @@ -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 diff --git a/.github/steps/3-avoiding-future-commits.md b/.github/steps/3-avoiding-future-commits.md index 4e14d05..e5555da 100644 --- a/.github/steps/3-avoiding-future-commits.md +++ b/.github/steps/3-avoiding-future-commits.md @@ -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` diff --git a/.github/workflows/0-welcome.yml b/.github/workflows/0-welcome.yml index 06f5c3a..d620864 100644 --- a/.github/workflows/0-welcome.yml +++ b/.github/workflows/0-welcome.yml @@ -70,4 +70,3 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} from_step: 0 to_step: 1 - branch_name: tbd-branch-name diff --git a/.github/workflows/1-removing-sensitive-data.yml b/.github/workflows/1-removing-sensitive-data.yml index 551a5ec..d4e81a4 100644 --- a/.github/workflows/1-removing-sensitive-data.yml +++ b/.github/workflows/1-removing-sensitive-data.yml @@ -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 @@ -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: @@ -74,4 +72,3 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} from_step: 1 to_step: 2 - branch_name: tbd-branch-name diff --git a/.github/workflows/2-removing-with-bfg.yml b/.github/workflows/2-removing-with-bfg.yml index f4953a1..9335288 100644 --- a/.github/workflows/2-removing-with-bfg.yml +++ b/.github/workflows/2-removing-with-bfg.yml @@ -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 @@ -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: @@ -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 @@ -72,4 +70,3 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} from_step: 2 to_step: 3 - branch_name: tbd-branch-name diff --git a/.github/workflows/3-avoiding-future-commits.yml b/.github/workflows/3-avoiding-future-commits.yml index ffde20f..ce103cb 100644 --- a/.github/workflows/3-avoiding-future-commits.yml +++ b/.github/workflows/3-avoiding-future-commits.yml @@ -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 @@ -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: @@ -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 @@ -74,4 +72,3 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} from_step: 3 to_step: X - branch_name: tbd-branch-name