Update quasar documentation: #119
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: Deploy documentation | |
| on: | |
| push: | |
| tags: | |
| - v1.** | |
| branches: | |
| - master | |
| jobs: | |
| build_deploy: | |
| name: Build and deploy documentation | |
| runs-on: self-hosted | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Define version name | |
| run: | | |
| if [ ${{ startsWith(github.ref_name, 'v1.') }} = true ]; then | |
| echo "VERSION_NAME=${{ github.ref_name }}" >> $GITHUB_ENV | |
| else | |
| echo "VERSION_NAME=latest" >> $GITHUB_ENV | |
| fi | |
| - name: Verify version's name | |
| run: | | |
| echo 'Version to build: ${{ env.VERSION_NAME }}' | |
| - name: Install dependencies | |
| run: | | |
| echo "${GITHUB_WORKSPACE}/" | |
| cd "${GITHUB_WORKSPACE}/" | |
| pip3 install --user -r ./Documentation/requirements.txt | |
| - name: Create new folder | |
| run: | | |
| echo "Creating new folder ${{ env.VERSION_NAME }}" | |
| mkdir -p /home/quasar/quasar/${{ env.VERSION_NAME }} | |
| - name: Build HTML documentation | |
| run: | | |
| cd "${GITHUB_WORKSPACE}/Documentation" | |
| export SPHINXBUILD=`which sphinx-build` | |
| sphinx-build -b html ./source ./_build/${{ env.VERSION_NAME }} | |
| - name: Build documentation PDF as ePUB | |
| run: | | |
| cd "${GITHUB_WORKSPACE}/Documentation" | |
| export SPHINXBUILD=`which sphinx-build` | |
| make epub | |
| cp ./build/epub/quasar.epub ./_build/${{ env.VERSION_NAME }} | |
| mv ./_build/${{ env.VERSION_NAME }}/quasar.epub ./_build/${{ env.VERSION_NAME }}/quasar\ ${{ env.VERSION_NAME }}.epub | |
| make latexpdf | |
| cp ./build/latex/quasar.pdf ./_build/${{ env.VERSION_NAME }} | |
| mv ./_build/${{ env.VERSION_NAME }}/quasar.pdf ./_build/${{ env.VERSION_NAME }}/quasar\ ${{ env.VERSION_NAME }}.pdf | |
| - name: Update server | |
| run: | | |
| echo 'Change directory location to build html' | |
| cd "${GITHUB_WORKSPACE}/Documentation/_build/${{ env.VERSION_NAME }}" | |
| echo 'Removing old build' | |
| rm -rf /home/quasar/quasar/${{ env.VERSION_NAME }} | |
| echo "${{ secrets.QUASAR_PASS }}" | sudo -S rm -rf /usr/share/nginx/quasar/${{ env.VERSION_NAME }} | |
| echo 'Copying new build to local' | |
| mkdir -p /home/quasar/quasar/${{ env.VERSION_NAME }} | |
| cp -a . /home/quasar/quasar/${{ env.VERSION_NAME }}/ | |
| echo "${{ secrets.QUASAR_PASS }}" | sudo -S mkdir -p /usr/share/nginx/quasar/${{ env.VERSION_NAME }} | |
| if [ ${{ startsWith(github.ref_name, 'v1.') }} = true ]; then | |
| echo 'Copying to version folder' | |
| sudo cp -r /home/quasar/quasar/${{ env.VERSION_NAME }} /usr/share/nginx/quasar/version | |
| else | |
| echo 'Copying to latest folder' | |
| sudo cp -r /home/quasar/quasar/${{ env.VERSION_NAME }} /usr/share/nginx/quasar | |
| fi | |
| echo 'Reloading nginx' | |
| echo "${{ secrets.QUASAR_PASS }}" | sudo -S nginx -s reload | |
| - name: Update latest | |
| if: ${{ startsWith(github.ref_name, 'v1.') != true }} | |
| run: | | |
| echo 'Change directory location to build html' | |
| cd "${GITHUB_WORKSPACE}/Documentation/_build/${{ env.VERSION_NAME }}" | |
| echo 'Removing old build' | |
| rm -rf /home/quasar/quasar/latest | |
| echo "${{ secrets.QUASAR_PASS }}" | sudo -S rm -rf /usr/share/nginx/quasar/latest | |
| echo 'Copying new build to local' | |
| mkdir -p /home/quasar/quasar/latest | |
| cp -a . /home/quasar/quasar/latest/ | |
| echo 'Copying to nginx folder' | |
| echo "${{ secrets.QUASAR_PASS }}" | sudo -S mkdir -p /usr/share/nginx/quasar/latest | |
| sudo cp -r /home/quasar/quasar/latest /usr/share/nginx/quasar | |
| echo 'Reloading nginx' | |
| echo "${{ secrets.QUASAR_PASS }}" | sudo -S nginx -s reload | |
| - name: Update versions | |
| run: | | |
| cd "${GITHUB_WORKSPACE}" | |
| QUASAR_PASS="${{ secrets.QUASAR_PASS }}" python3 ./Documentation/tools/update_versions.py | |
| - name: Update EOS web site | |
| run: | | |
| cd "${GITHUB_WORKSPACE}/Documentation/_build/${{ env.VERSION_NAME }}" | |
| echo 'Copying new build to EOS' | |
| cp -a . /eos/project-q/quasar/www/ | |
| rm -rf /eos/project-q/quasar/www/version | |
| cp -r /usr/share/nginx/quasar/version /eos/project-q/quasar/www |