3-add-a-code-example.yml

name: Step 3, Add a code example

# This step triggers after a commit on the branch `start-markdown`
# This step sets STEP to 4
# This step closes <details id=3> and opens <details id=4>

# 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:
  on_commit_start_markdown_code_example:
    name: On commit, start markdown, code example

    # We will only run this action when:
    # 1. This repository isn't the template repository
    # 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 }}

    # 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@v3
        with:
          fetch-depth: 0 # Let's get all the branches

      # Check that there is at least one code example in the markdown file
      - name: Check markdown syntax, code example
        run: ./.github/script/check-file.sh
        env:
          FILE: "index.md"
          SEARCH: "\\`\\`\\`"

      # Update README to close <details id=3> and open <details id=4>
      # and set STEP to '4'
      - name: Update to step 4
        uses: skills/action-update-step@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          from_step: 3
          to_step: 4
          branch_name: start-markdown