Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 1 | name: "Documentation" |
| 2 | |
| 3 | on: |
| 4 | pull_request: |
| 5 | push: |
| 6 | branches: |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 7 | - '2.x' |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 8 | - '3.x' |
| 9 | |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 10 | permissions: |
| 11 | contents: read |
| 12 | |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 13 | jobs: |
| 14 | build: |
| 15 | name: "Build" |
| 16 | |
| 17 | runs-on: ubuntu-latest |
| 18 | |
| 19 | steps: |
| 20 | - name: "Checkout code" |
| 21 | uses: actions/checkout@v2 |
| 22 | |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 23 | - name: "Set-up PHP" |
| 24 | uses: shivammathur/setup-php@v2 |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 25 | with: |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 26 | php-version: 8.1 |
| 27 | coverage: none |
| 28 | tools: "composer:v2" |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 29 | |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 30 | - name: Get composer cache directory |
| 31 | id: composercache |
| 32 | working-directory: doc/_build |
| 33 | run: echo "::set-output name=dir::$(composer config cache-files-dir)" |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 34 | |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 35 | - name: Cache dependencies |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 36 | uses: actions/cache@v2 |
| 37 | with: |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 38 | path: ${{ steps.composercache.outputs.dir }} |
| 39 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} |
| 40 | restore-keys: ${{ runner.os }}-composer- |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 41 | |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 42 | - name: "Install dependencies" |
| 43 | working-directory: doc/_build |
| 44 | run: composer install --prefer-dist --no-progress |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 45 | |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 46 | - name: "Build the docs" |
| 47 | working-directory: doc/_build |
| 48 | run: php build.php --disable-cache |
Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame] | 49 | |
| 50 | doctor-rst: |
| 51 | name: "DOCtor-RST" |
| 52 | |
| 53 | runs-on: ubuntu-latest |
| 54 | |
| 55 | steps: |
| 56 | - name: "Checkout code" |
| 57 | uses: actions/checkout@v2 |
| 58 | |
| 59 | - name: "Run DOCtor-RST" |
| 60 | uses: docker://oskarstark/doctor-rst |
| 61 | with: |
| 62 | args: --short |
| 63 | env: |
| 64 | DOCS_DIR: 'doc/' |