Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
artis3n authored Oct 11, 2023
1 parent 5be391d commit e3380b4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/steps/3-branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/artis3n/course-vault-github-oidc> 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
Expand Down
12 changes: 8 additions & 4 deletions .github/steps/4-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 <https://github.com/artis3n/course-vault-github-oidc> 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
Expand Down Expand Up @@ -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 <https://github.com/artis3n/course-vault-github-oidc> 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
Expand Down Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/4-verify-step.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
from_step: 4
to_step: 5
to_step: X

0 comments on commit e3380b4

Please sign in to comment.