Step 0, Welcome #6
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 0, Welcome | |
| # This step triggers after the learner creates a new repository from the template | |
| # This workflow updates from step 0 to step 1. | |
| # When creating a repository from a template, there is variability in the | |
| # order and timing of events that fire and when workflow triggers are registered. | |
| # Given that, these triggers are purposely broad to ensure this workflow is always triggered. | |
| # The conditions within the on_start job are to ensure it is only fully executed once. | |
| # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows | |
| on: | |
| create: | |
| workflow_dispatch: | |
| 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_start: | |
| name: On start | |
| needs: get_current_step | |
| # We will only run this action when: | |
| # 1. This repository isn't the template repository. | |
| # 2. The step is currently 0. | |
| # 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 == 0 }} | |
| # 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. | |
| # Update README from step 0 to step 1. | |
| - name: Update to step 1 | |
| uses: skills/action-update-step@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| from_step: 0 | |
| to_step: 1 | |
| # This is required to establish a related history for branches | |
| # after being created from the template repository. | |
| - name: Initialize repository | |
| run: ./.github/script/initialize-repository.sh --dry-run=false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |