Export Tutorials #7
Workflow file for this run
This file contains hidden or 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: "Export Tutorials" | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - "dev" | |
| - "master" | |
| paths: | |
| - 'tutorials/**/*.ipynb' | |
| jobs: | |
| # run on push | |
| export_tutorials_push: | |
| if: ${{ github.event_name != 'workflow_dispatch' }} | |
| permissions: write-all | |
| runs-on: ubuntu-latest | |
| env: | |
| TUTORIAL_TIMEOUT: 1200s | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.8 | |
| - name: Install dependencies | |
| run: | | |
| python3 -m pip install --upgrade pip .[tutorial] black[jupyter] | |
| - name: Setup FFmpeg | |
| uses: FedericoCarboni/setup-ffmpeg@v2 | |
| - id: files | |
| uses: jitterbit/get-changed-files@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| format: space-delimited | |
| - name: Configure git | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| - name: Export tutorials to .py and .html | |
| run: | | |
| set -x | |
| for file in ${{ steps.files.outputs.all }}; do | |
| if [[ $file == *.ipynb ]]; then | |
| filename=$(basename $file) | |
| pyfilename="${filename%.ipynb}.py" | |
| timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert $file --to python --output $pyfilename --output-dir=$(dirname $file) | |
| htmlfilename="${filename%.ipynb}"html | |
| htmldir="docs/source"/$(dirname $file) | |
| timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert --execute $file --to html --output $htmlfilename --output-dir=$htmldir | |
| fi | |
| done | |
| set +x | |
| - name: Run formatter | |
| run: black tutorials/ | |
| - uses: benjlevesque/[email protected] | |
| id: short-sha | |
| - name: Remove unwanted files | |
| run: | | |
| rm -rf build/ tutorials/tutorial4/data/ | |
| - name: Create Pull Request | |
| uses: peter-evans/[email protected] | |
| with: | |
| labels: maintenance | |
| title: Export tutorial changed in ${{ steps.short-sha.outputs.sha }} | |
| branch: export-tutorial-${{ steps.short-sha.outputs.sha }} | |
| base: ${{ github.head_ref }} | |
| commit-message: export tutorials changed in ${{ steps.short-sha.outputs.sha }} | |
| delete-branch: true | |
| # run on workflow_dispatch | |
| export_tutorials_workflow_dispatch: | |
| if: ${{ github.event_name == 'workflow_dispatch' }} | |
| permissions: write-all | |
| runs-on: ubuntu-latest | |
| env: | |
| TUTORIAL_TIMEOUT: 1200s | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.8 | |
| - name: Install dependencies | |
| run: | | |
| python3 -m pip install --upgrade pip .[tutorial] black[jupyter] | |
| - name: Setup FFmpeg | |
| uses: FedericoCarboni/setup-ffmpeg@v2 | |
| - name: Find all .ipynb files | |
| id: files | |
| run: | | |
| IPYNB_FILES=$(find tutorials -type f -name "*.ipynb") | |
| echo "all=$IPYNB_FILES" >> $GITHUB_ENV | |
| - name: Configure git | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| - name: Export tutorials to .py and .html | |
| run: | | |
| set -x | |
| for file in ${{ env.all }}; do | |
| if [[ $file == *.ipynb ]]; then | |
| filename=$(basename $file) | |
| pyfilename="${filename%.ipynb}.py" | |
| timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert $file --to python --output $pyfilename --output-dir=$(dirname $file) | |
| htmlfilename="${filename%.ipynb}"html | |
| htmldir="docs/source"/$(dirname $file) | |
| timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert --execute $file --to html --output $htmlfilename --output-dir=$htmldir | |
| fi | |
| done | |
| set +x | |
| - name: Run formatter | |
| run: black tutorials/ | |
| - uses: benjlevesque/[email protected] | |
| id: short-sha | |
| - name: Remove unwanted files | |
| run: | | |
| rm -rf build/ tutorials/tutorial4/data/ | |
| - name: Create Pull Request | |
| uses: peter-evans/[email protected] | |
| with: | |
| labels: maintenance | |
| title: Export tutorial changed in ${{ steps.short-sha.outputs.sha }} | |
| branch: export-tutorial-${{ steps.short-sha.outputs.sha }} | |
| base: ${{ github.head_ref }} | |
| commit-message: export tutorials changed in ${{ steps.short-sha.outputs.sha }} | |
| delete-branch: true |