From cd093c770939a0f31b51a4c694de0b4020ac4640 Mon Sep 17 00:00:00 2001 From: Dan Allan Date: Mon, 12 May 2025 17:37:59 -0700 Subject: [PATCH] Move GHA conditional into new guide. --- .github/workflows/ci_tests_run_notebooks.yml | 6 ------ contributing.md | 4 +++- index.md | 1 + maintainers.md | 16 ++++++++++++++++ 4 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 maintainers.md diff --git a/.github/workflows/ci_tests_run_notebooks.yml b/.github/workflows/ci_tests_run_notebooks.yml index 5f106c6..523c9df 100644 --- a/.github/workflows/ci_tests_run_notebooks.yml +++ b/.github/workflows/ci_tests_run_notebooks.yml @@ -17,9 +17,6 @@ concurrency: jobs: tests: - # Do not run the test matrix on PRs affecting the rendering - if: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'html rendering / skip testing') }} - name: ${{ matrix.os }} ${{ matrix.name }} runs-on: ${{ matrix.os }} strategy: @@ -57,9 +54,6 @@ jobs: gha_buildhtml: - # When label is used, we do run buildhtml on GHA to check if the publishing job will run or not. - # Use in case when new content has run into troubles on CircleCI. - if: ${{ (github.event_name == 'pull_request') && contains(github.event.pull_request.labels.*.name, 'GHA buildhtml') }} name: Buildhtml testing runs-on: ubuntu-latest steps: diff --git a/contributing.md b/contributing.md index 0118612..13c1a14 100644 --- a/contributing.md +++ b/contributing.md @@ -1,4 +1,6 @@ -# Guide to Contributing +# Guide for Contributors + +This guide is for contributing content to the tutorials. First, clone this repository. diff --git a/index.md b/index.md index 486a2b0..0913ae5 100644 --- a/index.md +++ b/index.md @@ -24,4 +24,5 @@ caption: Contributing --- contributing +maintainers ``` diff --git a/maintainers.md b/maintainers.md new file mode 100644 index 0000000..dcd954d --- /dev/null +++ b/maintainers.md @@ -0,0 +1,16 @@ +# Guide for Maintainers + +This guide for configuring and maintaining collection of executable +tutorials. + +## Specialized Patterns + +Sometimes it is convenient to disable a job in a GitHub Action on certain Pull +Requests. This may be added to the job to configure it to skip Pull Requests +that have a given label called `LABEL`. + +```yaml +jobs: + tests: + if: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'LABEL') }} +```