added fork update workflow #35
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: Docs | |
| on: | |
| pull_request: | |
| # paths: | |
| # - 'docs/**' | |
| # - '.github/workflows/docs.yml' | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| # - 'docs/**' | |
| # - '.github/workflows/docs.yml' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| docs: | |
| # OS must be the same as on djangoproject.com. | |
| runs-on: ubuntu-20.04 | |
| name: docs | |
| steps: | |
| - name: Eco-CI Init | |
| uses: green-coding-berlin/eco-ci-energy-estimation@test | |
| with: | |
| task: start-measurement | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| cache-dependency-path: 'docs/requirements.txt' | |
| - run: python -m pip install -r docs/requirements.txt | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling | |
| - name: Eco-CI Measurement | |
| uses: green-coding-berlin/eco-ci-energy-estimation@test | |
| with: | |
| task: get-measurement | |
| label: 'docs' | |
| - name: Eco-CI Results | |
| uses: green-coding-berlin/eco-ci-energy-estimation@test | |
| with: | |
| task: display-results | |
| blacken-docs: | |
| runs-on: ubuntu-latest | |
| name: blacken-docs | |
| steps: | |
| - name: Eco-CI Init | |
| uses: green-coding-berlin/eco-ci-energy-estimation@test | |
| with: | |
| task: start-measurement | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - run: python -m pip install blacken-docs | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| make black | |
| RESULT=`cat _build/black/output.txt` | |
| if [ "$RESULT" -gt 0 ]; then | |
| echo "💥 📢 Code blocks in documentation must be reformatted with blacken-docs 📢 💥" | |
| fi; | |
| exit $RESULT | |
| - name: Eco-CI Measurement | |
| uses: green-coding-berlin/eco-ci-energy-estimation@test | |
| with: | |
| task: get-measurement | |
| label: 'blacken-docs' | |
| - name: Eco-CI Results | |
| uses: green-coding-berlin/eco-ci-energy-estimation@test | |
| with: | |
| task: display-results |