Fix typos in contributor guide #1675
Workflow file for this run
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
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-mkdocs-task.md | |
| name: Check Website | |
| env: | |
| # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax | |
| GO_VERSION: "1.17" | |
| # See: https://github.com/actions/setup-python/tree/main#available-versions-of-python | |
| PYTHON_VERSION: "3.9" | |
| # See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows | |
| on: | |
| create: | |
| push: | |
| paths: | |
| - ".github/workflows/check-mkdocs-task.ya?ml" | |
| - "**/.npmrc" | |
| - "Taskfile.ya?ml" | |
| - "mkdocs.ya?ml" | |
| - "package.json" | |
| - "package-lock.json" | |
| - "poetry.lock" | |
| - "pyproject.toml" | |
| - "docs/**" | |
| - "docsgen/**" | |
| - "ruledocsgen/**" | |
| - "**.go" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/check-mkdocs-task.ya?ml" | |
| - "**/.npmrc" | |
| - "Taskfile.ya?ml" | |
| - "mkdocs.ya?ml" | |
| - "package.json" | |
| - "package-lock.json" | |
| - "poetry.lock" | |
| - "pyproject.toml" | |
| - "docs/**" | |
| - "docsgen/**" | |
| - "ruledocsgen/**" | |
| - "**.go" | |
| schedule: | |
| # Run periodically to catch breakage caused by external changes. | |
| - cron: "0 5 * * WED" | |
| workflow_dispatch: | |
| repository_dispatch: | |
| jobs: | |
| run-determination: | |
| runs-on: ubuntu-latest | |
| permissions: {} | |
| outputs: | |
| result: ${{ steps.determination.outputs.result }} | |
| steps: | |
| - name: Determine if the rest of the workflow should run | |
| id: determination | |
| run: | | |
| RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" | |
| # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. | |
| if [[ | |
| "${{ github.event_name }}" != "create" || | |
| "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX | |
| ]]; then | |
| # Run the other jobs. | |
| RESULT="true" | |
| else | |
| # There is no need to run the other jobs. | |
| RESULT="false" | |
| fi | |
| echo "result=$RESULT" >> $GITHUB_OUTPUT | |
| check: | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install Poetry | |
| run: pip install poetry | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: package.json | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Build website | |
| run: task website:check |