updates for Example CI #297

Workflow file for this run

.github/workflows/Example.yml at 30ae9e6

	name: Examples

	on:
	workflow_dispatch:
	pull_request:
	push:
	branches:
	- main
	paths:
	- 'src/**'
	- 'examples/jupyter-src/**'
	- 'examples/pluto-src/**'
	- '.github/workflows/Example.yml'
	- 'Project.toml'

	concurrency: # allow only one parallel job as conflicts can emerge from example-gathering branch
	group: ${{ github.workflow }}
	cancel-in-progress: true

	jobs:
	clean-ci-example-gathering-branch:
	runs-on: ubuntu-latest
	steps:
	- name: "Check out repository"
	uses: actions/checkout@v4

	- name: "clean branch"
	env:
	CI_COMMIT_MESSAGE: cleaned[${{ github.ref }}]
	CI_COMMIT_AUTHOR: github-actions[bot]
	EXAMPLES_PATH: examples
	# Fetch all and clear the stash list. Include all files from the examples folder to the stash and switch the branch.
	# Reset the branch and remove all current files in the examples folder.
	# Checkout the last stash to restore the new notebooks and apply the stash index to restore all other new files in the folder.
	run: \|
	git fetch --all
	git stash clear
	git switch ci-example-gathering
	git reset --hard origin/ci-example-gathering
	rm -rf ${{ env.EXAMPLES_PATH }}
	git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
	git config --global user.email "${{ env.CI_COMMIT_AUTHOR }}@users.noreply.github.com"
	git config --global core.autocrlf false
	git add ${{ env.EXAMPLES_PATH }}
	git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
	git push origin ci-example-gathering

	jupyter:
	needs: [clean-ci-example-gathering-branch]
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [windows-latest] # , ubuntu-latest]
	file-name: [growing_horizon_ME, modelica_conference_2021, simple_hybrid_CS, simple_hybrid_ME, mdpi_2022, juliacon_2023]
	julia-version: ['1.10']
	julia-arch: [x64]
	experimental: [false]

	steps:
	- name: "Check out repository"
	uses: actions/checkout@v4

	- name: "Set up Julia"
	uses: julia-actions/setup-julia@latest
	with:
	version: ${{ matrix.julia-version }}
	arch: ${{ matrix.julia-arch }}

	- name: "Install dependencies"
	run: julia --project=examples/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'

	- name: "Install packages"
	run: pip install jupyter nbconvert

	- name: "Execute and synchronize all files"
	env:
	FILE: examples/jupyter-src/${{ matrix.file-name }}.ipynb
	run: \|
	jupyter nbconvert --ExecutePreprocessor.kernel_name="julia-1.10" --to notebook --inplace --execute ${{ env.FILE }}
	jupyter nbconvert --to script ${{ env.FILE }}
	jupyter nbconvert --to markdown ${{ env.FILE }}

	- name: "Fix GIFs"
	run: \|
	echo "starting gif fixing"
	mv examples/jupyter-src/gif_*.gif examples/jupyter-src/${{ matrix.file-name }}_files
	$env:Path += ";C:\Program Files\Git\usr\bin"
	awk '{if($0~/<img src="data:image\/gif;base64,[[:alpha:],[:digit:],\/,+,=]" \/>/) {sub(/<img src="data:image\/gif;base64,[[:alpha:],[:digit:],\/,+,=]" \/>/,"![gif](${{ matrix.file-name }}_files\/gif_"++i".gif)")}}1' examples/jupyter-src/${{ matrix.file-name }}.md > examples/jupyter-src/tmp_${{ matrix.file-name }}.md
	mv -Force examples/jupyter-src/tmp_${{ matrix.file-name }}.md examples/jupyter-src/${{ matrix.file-name }}.md
	echo "gifs should be fixed"

	- name: "auto-commit for gathering (retry on merge)"
	if: success()
	uses: nick-fields/retry@v3
	env:
	CI_COMMIT_MESSAGE: jupyter-example-${{ matrix.os }}-${{ matrix.file-name }}-${{ matrix.julia-version }}-${{ matrix.julia-arch }}-${{ matrix.experimental }}[${{ github.ref }}]
	CI_COMMIT_AUTHOR: github-actions[bot]
	EXAMPLES_PATH: examples
	# Fetch all and clear the stash list. Include all files from the examples folder to the stash and switch the branch.
	# Reset the branch and remove all current files in the examples folder.
	# Checkout the last stash to restore the new notebooks and apply the stash index to restore all other new files in the folder.
	with:
	timeout_minutes: 999
	max_attempts: 10
	warning_on_retry: false
	shell: bash
	command: \|
	git fetch --all
	git stash clear
	git stash --include-untracked -- ${{ env.EXAMPLES_PATH }}
	git switch ci-example-gathering
	git reset --hard origin/ci-example-gathering
	git checkout stash -f -- ${{ env.EXAMPLES_PATH }}
	git stash apply --index
	git stash drop
	git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
	git config --global user.email "${{ env.CI_COMMIT_AUTHOR }}@users.noreply.github.com"
	git config --global core.autocrlf false
	git add ${{ env.EXAMPLES_PATH }}
	git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
	git push origin ci-example-gathering \|\| (git reset --soft HEAD~1 && (exit 1))

	pluto:
	needs: [clean-ci-example-gathering-branch]
	runs-on: ubuntu-latest
	steps:
	- name: "Check out repository"
	uses: actions/checkout@v4

	- name: "Set up Julia"
	uses: julia-actions/setup-julia@latest
	with:
	version: '1.10'

	- run: julia -e 'using Pkg; Pkg.add("PlutoSliderServer"); Pkg.add("FMIFlux")'
	- run: julia -e 'using PlutoSliderServer; PlutoSliderServer.export_directory("examples/pluto-src")'

	- name: "auto-commit for gathering (retry on merge)"
	if: success()
	uses: nick-fields/retry@v3
	env:
	CI_COMMIT_MESSAGE: pluto-examples[${{ github.ref }}]
	CI_COMMIT_AUTHOR: github-actions[bot]
	EXAMPLES_PATH: examples
	# Fetch all and clear the stash list. Include all files from the examples folder to the stash and switch the branch.
	# Reset the branch and remove all current files in the examples folder.
	# Checkout the last stash to restore the new notebooks and apply the stash index to restore all other new files in the folder.
	with:
	timeout_minutes: 999
	max_attempts: 10
	warning_on_retry: false
	shell: bash
	command: \|
	git fetch --all
	git stash clear
	git stash --include-untracked -- ${{ env.EXAMPLES_PATH }}
	git switch ci-example-gathering
	git reset --hard origin/ci-example-gathering
	git checkout stash -f -- ${{ env.EXAMPLES_PATH }}
	git stash apply --index
	git stash drop
	git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
	git config --global user.email "${{ env.CI_COMMIT_AUTHOR }}@users.noreply.github.com"
	git config --global core.autocrlf false
	git pull
	git add ${{ env.EXAMPLES_PATH }}
	git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
	git push origin ci-example-gathering \|\| (git reset --soft HEAD~1 && (exit 1))

	filecheck:
	needs: [jupyter, pluto]
	runs-on: ubuntu-latest
	steps:
	- name: "Check out repository"
	uses: actions/checkout@v4

	- name: Download examples
	run: \|
	git fetch --all
	git stash clear
	git stash --include-untracked -- ${{ env.EXAMPLES_PATH }}
	git switch ci-example-gathering
	git reset --hard origin/ci-example-gathering

	- name: Check if the example files generated are valid (if jupyter-examples failed, svgs are missing; jupyter command does not fail even if examples fail)
	uses: andstor/file-existence-action@v3
	with:
	files: "examples/jupyter-src//.svg"
	fail: true

	auto-commit:
	needs: [jupyter, pluto, filecheck]
	if: github.event_name != 'pull_request'
	runs-on: ubuntu-latest
	steps:
	- name: Check out repository
	uses: actions/checkout@v4

	- name: Download examples
	run: \|
	git fetch --all
	git stash clear
	git stash --include-untracked -- ${{ env.EXAMPLES_PATH }}
	git switch ci-example-gathering
	git reset --hard origin/ci-example-gathering

	- name: auto-commit
	env:
	CI_COMMIT_MESSAGE: Jupyter modified .ipynb & exported md files; Pluto static html exported files
	CI_COMMIT_AUTHOR: github-actions[bot]
	EXAMPLES_PATH: examples
	# Fetch all and clear the stash list. Include all files from the examples/jupyter-src folder to the stash and switch the branch.
	# Reset the branch and remove all current files in the examples/jupyter-src folder.
	# Checkout the last stash to restore the new notebooks and apply the stash index to restore all other new files in the folder.
	run: \|
	git fetch --all
	git stash clear
	git stash --include-untracked -- ${{ env.EXAMPLES_PATH }}
	git switch examples
	git reset --hard origin/examples
	rm -rf ${{ env.EXAMPLES_PATH }}
	git checkout stash -f -- ${{ env.EXAMPLES_PATH }}
	git stash apply --index
	git stash drop
	git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
	git config --global user.email "${{ env.CI_COMMIT_AUTHOR }}@users.noreply.github.com"
	git config --global core.autocrlf false
	git add ${{ env.EXAMPLES_PATH }}
	git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
	git push origin examples

	call-docu:
	needs: auto-commit
	if: github.event_name != 'pull_request'
	runs-on: ubuntu-latest
	steps:
	# Trigger an repoisitory dispath event
	- name: Repository Dispatch
	uses: peter-evans/repository-dispatch@v2
	with:
	event-type: trigger-docu

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

updates for Example CI #297

Workflow file

updates for Example CI #297

Jobs

Run details

Workflow file for this run