Update index.md #5
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Step 1, Add headers | |
| # This step triggers after a commit on the branch `start-markdown`. | |
| # This workflow updates from step 1 to step 2. | |
| # This will run every time we create push a commit to `start-markdown`. | |
| # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - start-markdown | |
| # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication | |
| permissions: | |
| # Need `contents: read` to checkout the repository. | |
| # Need `contents: write` to update the step metadata. | |
| contents: write | |
| jobs: | |
| # Get the current step to only run the main job when the learner is on the same step. | |
| get_current_step: | |
| name: Check current step number | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - id: get_step | |
| run: | | |
| echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT | |
| outputs: | |
| current_step: ${{ steps.get_step.outputs.current_step }} | |
| on_commit_start_markdown_headers: | |
| name: On commit, start markdown, headers | |
| needs: get_current_step | |
| # We will only run this action when: | |
| # 1. This repository isn't the template repository. | |
| # 2. The step is currently 1. | |
| # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts | |
| # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions | |
| if: >- | |
| ${{ !github.event.repository.is_template | |
| && needs.get_current_step.outputs.current_step == 1 }} | |
| # We'll run Ubuntu for performance instead of Mac or Windows. | |
| runs-on: ubuntu-latest | |
| steps: | |
| # We'll need to check out the repository so that we can edit the README. | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Let's get all the branches. | |
| # Check that there is at least one header in the markdown file. | |
| - name: Check markdown syntax, header | |
| uses: skills/action-check-file@v1 | |
| with: | |
| file: "index.md" | |
| search: "(?<!#)#{1,6}([\ \\t](.*))?$" | |
| # In README.md, switch step 1 for step 2. | |
| - name: Update to step 2 | |
| uses: skills/action-update-step@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| from_step: 1 | |
| to_step: 2 | |
| branch_name: start-markdown |