Automatize Tutorials html, py files creation (#496)
* workflow to export tutorials ---------
This commit is contained in:
committed by
FilippoOlivo
parent
8dfc9d19db
commit
3ff9f0c9a2
72
.github/workflows/export_tutorials.yml
vendored
Normal file
72
.github/workflows/export_tutorials.yml
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
name: "Export Tutorials"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "**" # Run on push on all branches
|
||||
paths:
|
||||
- 'tutorials/**/*.ipynb'
|
||||
jobs:
|
||||
export_tutorials:
|
||||
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: |
|
||||
# Dependencies for tutorials
|
||||
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=$(echo ${filename%?????})py
|
||||
timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert $file --to python --output $pyfilename --output-dir=$(dirname $file)
|
||||
htmlfilename=$(echo ${filename%?????} | sed -e 's/-//g')html
|
||||
htmldir="docs/source"/$(echo ${file%?????} | sed -e 's/-//g')html
|
||||
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/short-sha@v2.1
|
||||
id: short-sha
|
||||
|
||||
- name: Remove unwanted files
|
||||
run: |
|
||||
rm -rf build/
|
||||
- name: Create Pull Request
|
||||
uses: peter-evans/create-pull-request@v5.0.2
|
||||
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
|
||||
Reference in New Issue
Block a user