Automatically update branches with executed notebooks #83
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
| # This code is a Qiskit project. | |
| # | |
| # (C) Copyright IBM 2023. | |
| # | |
| # This code is licensed under the Apache License, Version 2.0. You may | |
| # obtain a copy of this license in the LICENSE file in the root directory | |
| # of this source tree or at http://www.apache.org/licenses/LICENSE-2.0. | |
| # | |
| # Any modifications or derivative works of this code must retain this | |
| # copyright notice, and modified files need to carry a notice indicating | |
| # that they have been altered from the originals. | |
| name: Test notebooks | |
| on: | |
| # Three event types can trigger this workflow: | |
| # 1. Pull request | |
| # On creating or pushing to a PR branch, this action runs any changed | |
| # notebooks and reports pass / fail. This is to catch broken code | |
| # examples. | |
| # 2. Labeled | |
| # On adding an `🤖 Auto execute` label (id: 6409509633) to a PR, this | |
| # workflow executes any changed notebooks, then pushes the updates to the | |
| # PR branch. This makes it easy to quickly get notebooks executed in the | |
| # CI environment. | |
| # 3. Workflow dispatch | |
| # When triggered by a workflow_dispatch event, we execute all notebooks, | |
| # and make a PR to the branch with the updated notebooks. This is handy | |
| # when upgrading qiskit package versions. | |
| pull_request: | |
| paths: | |
| - "docs/**/*.ipynb" | |
| - "!docs/api/**/*" | |
| types: [opened, synchronize, labeled] | |
| issue_comment: | |
| workflow_dispatch: | |
| jobs: | |
| execute: | |
| name: Execute notebooks | |
| runs-on: ubuntu-latest | |
| if: github.event.action != 'labeled' || github.event.label.id == 6409509633 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| cache: "pip" | |
| - name: Get all changed files | |
| if: github.event_name == 'pull_request' | |
| id: all-changed-files | |
| uses: tj-actions/changed-files@af2816c65436325c50621100d67f6e853cd1b0f1 | |
| with: | |
| files: docs/**/*.ipynb | |
| separator: "\n" | |
| - name: Check for notebooks that require LaTeX | |
| if: github.event_name == 'pull_request' | |
| id: latex-changed-files | |
| uses: tj-actions/changed-files@af2816c65436325c50621100d67f6e853cd1b0f1 | |
| with: | |
| # Add your notebook to this list if it needs latex to run | |
| files: | | |
| docs/build/circuit-visualization.ipynb | |
| - name: Install LaTeX dependencies | |
| if: github.event_name == 'workflow_dispatch' || steps.latex-changed-files.outputs.any_changed == 'true' | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install texlive-pictures texlive-latex-extra poppler-utils | |
| - name: Install Python packages | |
| # This is to save our account in the next step. Note that the | |
| # package will be re-installed during the "Run tox" step. | |
| run: pip install qiskit-ibm-runtime tox | |
| - name: Save IBM Quantum account | |
| if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository | |
| shell: python | |
| run: | | |
| # This saves the result for qiskit-ibm-provider too | |
| from qiskit_ibm_runtime import QiskitRuntimeService | |
| QiskitRuntimeService.save_account( | |
| channel="ibm_quantum", | |
| instance="ibm-q/open/main", | |
| token="${{ secrets.IBM_QUANTUM_TEST_TOKEN }}", | |
| set_as_default=True | |
| ) | |
| - name: Cache tox environment | |
| uses: actions/cache@v3 | |
| with: | |
| path: ".tox" | |
| key: ${{ hashFiles('scripts/nb-tester/requirements.txt') }} | |
| - name: Run tox on changed files | |
| if: github.event_name == 'pull_request' | |
| shell: python | |
| run: | | |
| import subprocess | |
| files = """${{ steps.all-changed-files.outputs.all_changed_files }}""" | |
| args = ["tox", "--"] + files.split("\n") + ["--write"] | |
| subprocess.run(args, check=True) | |
| - name: Run tox on all files | |
| if: github.event_name == 'workflow_dispatch' | |
| run: tox -- --write | |
| - name: Upload executed notebooks | |
| if: github.event_name == 'pull_request' && github.event.action != 'labeled' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Executed notebooks | |
| path: ${{ steps.all-changed-files.outputs.all_changed_files }} | |
| - name: Push to branch | |
| if: github.event.action == 'labeled' | |
| run: | | |
| git config user.name github-actions | |
| git config user.email github-actions@github.com | |
| git config pull.merge true | |
| git add **/*.ipynb | |
| git commit -m "Execute notebooks" --allow-empty | |
| git pull origin ${{ github.head_ref }} | |
| git push origin HEAD:${{ github.head_ref }} | |
| - name: Remove label from PR | |
| uses: actions/github-script@v6 | |
| if: github.event.action == 'labeled' | |
| with: | |
| script: | | |
| github.rest.issues.removeLabel({ | |
| issue_number: ${{ github.event.number }}, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| name: ["${{ github.event.label.name }}"] | |
| }) | |
| - name: Create pull request | |
| if: github.event_name == 'workflow_dispatch' | |
| uses: peter-evans/create-pull-request@5b5eb8d8d0d7f95a473039666b7a2ee417ab24e1 | |
| with: | |
| title: "[Bot] Execute notebooks" | |
| commit-message: Re-run all notebooks | |
| branch: ACTIONS/${{ github.run_id }} | |
| body: | | |
| Executes notebooks. | |
| > [!NOTE] | |
| > This pull request was created by a GitHub action. |