diff --git a/.github/steps/3-branches.md b/.github/steps/3-branches.md index b01cb0c..5e6a683 100644 --- a/.github/steps/3-branches.md +++ b/.github/steps/3-branches.md @@ -138,6 +138,7 @@ If you still have this repository open from the previous activity, make sure to 4. Replace this step with the following code. > [!IMPORTANT] > Replace the `YOUR_REPO` section with the `org/repo` string that applies to the repository you created from this course. + For example, the course template hosted at would use: `"sub": "repo:artis3n/course-vault-github-oidc:ref:refs/heads/main"`. The workflow won't run unless the `org/repo` string is correct for your repository. ```yml diff --git a/.github/steps/4-environments.md b/.github/steps/4-environments.md index a8a0e96..66d0dfc 100644 --- a/.github/steps/4-environments.md +++ b/.github/steps/4-environments.md @@ -22,10 +22,12 @@ If you still have this repository open from the previous activity, make sure to git pull ``` 1. From the code editor, make sure you are working on the `main` branch. -**For this activity to properly update you to the next step, you must push code to the `main` branch.** + > [!IMPORTANT] + > For this activity to properly update you to the next step, you must push code to the `main` branch. + Environments are not restricted to the `main` branch by default, but this workflow must run from the `main` branch for this course to properly track your progress. 1. In your code editor, open the file `.github/workflows/4-environment.yml`. -1. There are two jobs in this workflow file! +2. There are two jobs in this workflow file! `staging` and `prod`. We'll configure a Vault role for each job. Notice the `staging` job includes the `environment: Staging` attribute and the `prod` job includes the `environment: Production` attribute. @@ -44,9 +46,10 @@ To learn more about using Environments in workflow files, see [GitHub's workflow environment: Production ``` 1. Under the **staging** job, locate the step `name: Create an OIDC Role`. -1. Under the **staging** job, replace this step with the following code. +2. Under the **staging** job, replace this step with the following code. > [!IMPORTANT] > Replace the `YOUR_REPO` section with the `org/repo` string that applies to the repository you created from this course. + For example, the course template hosted at would use: `"sub": "repo:artis3n/course-vault-github-oidc:environment:Staging"`. The workflow won't run unless the `org/repo` string is correct for your repository. ```yml @@ -98,6 +101,7 @@ Enter the `GIVE_ME_A_NAME` role name you chose in the previous step. 3. Under the **prod** job, replace this step with the following code. > [!IMPORTANT] > Replace the `YOUR_REPO` section with the `org/repo` string that applies to the repository you created from this course. + For example, the course template hosted at would use: `"sub": "repo:artis3n/course-vault-github-oidc:environment:Production"`. The workflow won't run unless the `org/repo` string is correct for your repository. ```yml @@ -125,7 +129,7 @@ In the same code block, replace `GIVE_ME_A_NAME` with an alphanumeric (plus `_` 1. Under the **prod** job, locate the next step in the job, `name: Retrieve Secrets`. ```yml - name: Retrieve Secrets - uses: hashicorp/vault-action@v2.4.3 + uses: hashicorp/vault-action@v2 id: secrets with: # TODO: Don't forget to enter the role name you created above! diff --git a/.github/workflows/4-verify-step.yml b/.github/workflows/4-verify-step.yml index 6c38e5b..7525ba1 100644 --- a/.github/workflows/4-verify-step.yml +++ b/.github/workflows/4-verify-step.yml @@ -64,4 +64,4 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} from_step: 4 - to_step: 5 + to_step: X