Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,28 @@ jobs:
name: Build documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
# 6.0.2
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

# 6.2.0
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
with:
python-version: '3.10'
cache: 'pip'
cache-dependency-path: '**/requirements*.txt'

- name: Install dependencies
run: |
python3 -m pip install -U pip
pip install -U -r requirements.txt

- name: Sphinx build
run: |
echo "::add-matcher::.github/matchers/sphinx.json"
make -C docs/ html SPHINXOPTS="${SPHINXOPTS}"
echo "::remove-matcher owner=sphinx::"
env:
SPHINXOPTS: -n -W -a --keep-going

- name: Upload docs as artifacts
uses: actions/upload-artifact@v4
with:
Expand All @@ -43,21 +48,26 @@ jobs:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
# 6.0.2
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

# 6.2.0
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
with:
python-version: '3.10'
cache: 'pip'
cache-dependency-path: '**/requirements*.txt'

- name: Install dependencies
run: |
python3 -m pip install -U pip
pip install -U -r requirements.txt

- name: Sphinx linkcheck
run: |
make -C docs/ linkcheck SPHINXOPTS="${SPHINXOPTS}"
env:
SPHINXOPTS: -n -W -a --keep-going

- name: Sphinx linkcheck collect
if: always()
run: |
Expand All @@ -66,7 +76,9 @@ jobs:
sed 's@^@docs/@' docs/_build/linkcheck/output.txt
echo "::remove-matcher owner=sphinx::"
echo "::remove-matcher owner=sphinx-warn::"
- uses: actions/upload-artifact@v4

# 7.0.0
- uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f
if: always()
with:
name: Linkcheck report
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/update-flatpak-builder-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ jobs:
name: Update Flatpak Builder docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# 6.0.2
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

- name: Install dependencies
run: |
sudo apt install -y appstream git libxml2-utils
Expand Down Expand Up @@ -49,7 +51,8 @@ jobs:

- name: Create pull request
if: ${{ success() && steps.vercomp.outcome == 'success' }}
uses: peter-evans/create-pull-request@v7
# 8.1.0
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch-suffix: "random"
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/update-flatpak-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ jobs:
name: Update Flatpak docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# 6.0.2
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

- name: Install dependencies
run: |
sudo apt install -y appstream git libxml2-utils
Expand Down Expand Up @@ -49,7 +51,8 @@ jobs:

- name: Create pull request
if: ${{ success() && steps.vercomp.outcome == 'success' }}
uses: peter-evans/create-pull-request@v7
# 8.1.0
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch-suffix: "random"
Expand Down
Loading