Add tips for Flatpak users #72
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
| # Rebuild the docs on changes to dev or on a new release | |
| name: Docs Update | |
| concurrency: gh-pages | |
| on: | |
| push: | |
| branches: | |
| - dev | |
| release: | |
| types: [published] | |
| jobs: | |
| docs_rebuild: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: set up development environment | |
| run: | | |
| $CONDA/bin/conda env create -q -f environment.yml | |
| source $CONDA/bin/activate enderchest | |
| pip install -e .[test,sftp] | |
| - name: configure git | |
| run: | | |
| git config --global user.name docs-golem | |
| git config --global user.email [email protected] | |
| - name: Configure SSH | |
| if: matrix.os != 'windows-latest' | |
| run: | | |
| ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -N '' | |
| cat > ~/.ssh/config <<EOF | |
| Host * | |
| IdentityFile ~/.ssh/id_ed25519 | |
| EOF | |
| cat ~/.ssh/id_ed25519.pub > ~/.ssh/authorized_keys | |
| chmod -R 700 ~/.ssh | |
| ssh -o 'StrictHostKeyChecking no' $USER@$HOSTNAME "echo It works" | |
| - name: generate coverage report (by running unit tests) | |
| run: | | |
| source $CONDA/bin/activate enderchest | |
| coverage run --source enderchest -m pytest --use-local-ssh | |
| coverage html | |
| coverage report -m | |
| - name: generate coverage badge | |
| uses: tj-actions/coverage-badge-py@v2 | |
| - name: generate lint badge | |
| run: | | |
| source $CONDA/bin/activate enderchest | |
| pylint enderchest --output docs/lint-report.txt --exit-zero | |
| anybadge -l pylint -v $(cat docs/lint-report.txt | sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p') -f pylint.svg 0=darkred 4=red 7=orange 9=yellow 10=green | |
| - name: add badges to docs | |
| run: | | |
| mv *.svg docs/img/ | |
| - name: deploy dev docs | |
| if: ${{ github.event_name == 'push' }} | |
| run: | | |
| source $CONDA/bin/activate enderchest | |
| mike deploy ${{ github.ref_name }} --push | |
| - name: deploy release docs | |
| if: ${{ github.event_name == 'release' && !github.event.release.prerelease }} | |
| run: | | |
| source $CONDA/bin/activate enderchest | |
| mike deploy ${{ github.ref_name }} release --push -u |