feat: remove a bunch of non-sensical stuff that developers and resear… #75
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: SHACL Documentation Generation | |
| on: | |
| push: | |
| paths: | |
| - 'src/imaging-ontology/**' | |
| pull_request: | |
| paths: | |
| - 'src/imaging-ontology/**' | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python and install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install rdflib | |
| - name: Enrich ontology with rdflib | |
| id: enrich | |
| run: | | |
| python tools/python/docs/sparql.py | |
| echo "enriched_file=/tmp/enriched.ttl" >> $GITHUB_ENV | |
| - name: Set up Java 11 | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'temurin' | |
| java-version: '11' | |
| - name: Install Graphviz | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y graphviz | |
| - name: Set DOT_PATH environment variable | |
| run: echo "GRAPHVIZ_DOT=/usr/bin/dot" >> $GITHUB_ENV | |
| - name: Download SHACL Play CLI | |
| run: | | |
| wget https://github.com/sparna-git/shacl-play/releases/download/0.10.2/shacl-play-app-0.10.2-onejar.jar -O shacl-play-cli.jar | |
| - name: Generate Documentation | |
| run: | | |
| java -jar shacl-play-cli.jar \ | |
| doc \ | |
| -d \ | |
| -i ${{ env.enriched_file }} \ | |
| -l en \ | |
| -o docs/index.html | |
| - name: Generate Ontology Diagram | |
| run: | | |
| java -jar shacl-play-cli.jar \ | |
| draw \ | |
| -i ${{ env.enriched_file }} \ | |
| -o docs/ontology.svg | |
| - name: Commit generated docs | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email "github-actions[bot]@users.noreply.github.com" | |
| git add docs/index.html | |
| git add docs/ontology.svg | |
| git commit -m "Update generated docs" || echo "Nothing to commit" | |
| git push | |
| - name: Upload generated documentation as an artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: shacl-documentation | |
| path: docs/index.html |