debugging documentation build: implement remaining docs #81
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
| name: Build documentation | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: windows-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v3 | |
| - name: Add MSBuild to PATH | |
| uses: microsoft/[email protected] | |
| - name: Install 7-Zip | |
| run: | | |
| Invoke-WebRequest -Uri https://www.7-zip.org/a/7z1900-x64.exe -OutFile 7z.exe | |
| Start-Process -Wait -FilePath 7z.exe | |
| Remove-Item -Force 7z.exe | |
| - name: Extract 3rdparty.zip | |
| run: | | |
| Start-Process -Wait -FilePath 'C:\Program Files\7-Zip\7z.exe' -ArgumentList "x -y .\development\3rdparty.zip -o.\development\" | |
| - name: Build Documentation | |
| run: msbuild /p:Configuration=Release documentation\Cpacs_doc_project.shfbproj | |
| - name: Add dsgvo footer to html docs | |
| run: python .\documentation\Cpacs_doc_dsgvo.py | |
| - name: Package HTML Docs | |
| run: 7z a -tzip .\build\doc\htmlDocs.zip .\build\doc\* | |
| - name: Upload Artifacts | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: cpacsDocs | |
| path: | | |
| .\build\doc\*.chm | |
| .\build\doc\htmlDocs.zip | |
| deploy: | |
| needs: build | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Deploy to the github-pages environment | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| # Specify runner + deployment step | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Download html zip | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: cpacsDocs | |
| - name: Extract HTML Docs | |
| run: | | |
| 7z x -y htmlDocs.zip | |
| - name: Fix permissions | |
| run: | | |
| chmod -c -R +rX "." | while read line; do | |
| echo "::warning title=Invalid file permissions automatically fixed::$line" | |
| done | |
| - name: Upload Artifacts | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: . | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} |