Update CHANGELOG for 2.1.2 release: add bug-fix details and PR refere… #32
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
| # This is a basic workflow to help you get started with Actions | |
| name: CI | |
| on: | |
| push: | |
| branches: [ main ] | |
| # pull_request: | |
| # branches: [ main ] | |
| jobs: | |
| build_documentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: "3.10" | |
| - name: Run Documentation Doctests | |
| run: | | |
| pip install sphinx sphinx-multiversion | |
| pip install kentigern | |
| pip install -r requirements.txt | |
| pip install -r requirements_dev.txt | |
| pip install . | |
| cd docs | |
| echo "Running doctests..." | |
| make doctest > doctest_output.txt 2>&1 || true | |
| if grep -q "failed" doctest_output.txt; then | |
| echo "::warning file=docs/doctest_output.txt,title=Doctest Failures::Some documentation examples failed testing. See the full output for details." | |
| echo "Doctest Summary:" | |
| grep -A 5 "Doctest summary" doctest_output.txt || echo "No summary found" | |
| else | |
| echo "All doctests passed!" | |
| fi | |
| cat doctest_output.txt | |
| continue-on-error: true | |
| - name: Upload Doctest Results | |
| if: always() | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: doctest-results | |
| path: docs/doctest_output.txt | |
| retention-days: 30 | |
| - name: Build HTML Docs | |
| run: | | |
| cd docs | |
| make multi | |
| - name: Add redirect to current version | |
| run: | | |
| echo "<!DOCTYPE html><html><head><title>Redirecting to main branch</title><meta charset=\"utf-8\"><meta http-equiv=\"refresh\" content=\"0; url=./main/index.html\"> <link rel=\"canonical\" href=\"https://asimov.docs.ligo.org/asimov/main/index.html\"></head></html>" > docs/_build/index.html | |
| - name: SCP Deploy HTML Docs | |
| uses: horochx/deploy-via-scp@v1.0.1 | |
| with: | |
| local: docs/_build/html/* | |
| remote: /home/danwilliams/code.daniel-williams.co.uk/minke | |
| host: ${{ secrets.sshhost }} | |
| user: ${{ secrets.sshuser }} | |
| key: ${{ secrets.sshkey }} |