|
1 | | -name: Publish REST API Docs |
2 | | -on: [push, pull_request] |
| 1 | +name: Publish REST API Docs |
| 2 | +on: |
| 3 | + push: |
| 4 | + branches: |
| 5 | + - main |
| 6 | + pull_request: |
| 7 | + |
3 | 8 | jobs: |
4 | 9 | make-restapi-docs: |
5 | 10 | name: Checkout phpList rest-api and generate docs specification (OpenAPI latest-restapi.json) |
6 | 11 | runs-on: ubuntu-20.04 |
7 | 12 | steps: |
8 | | - - name: Checkout |
9 | | - uses: actions/checkout@v2 |
10 | | - - name: Setup PHP, with composer and extensions |
11 | | - uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php |
| 13 | + - name: Checkout Repository |
| 14 | + uses: actions/checkout@v3 |
| 15 | + |
| 16 | + - name: Setup PHP with Composer and Extensions |
| 17 | + uses: shivammathur/setup-php@v2 |
12 | 18 | with: |
13 | | - php-version: 7.4 |
| 19 | + php-version: 8.1 |
14 | 20 | extensions: mbstring, dom, fileinfo, mysql |
15 | | - - name: Get composer cache directory |
16 | | - id: composer-cache |
17 | | - run: echo "::set-output name=dir::$(composer config cache-files-dir)" |
18 | | - - name: Cache composer dependencies |
19 | | - uses: actions/cache@v2 |
| 21 | + |
| 22 | + - name: Cache Composer Dependencies |
| 23 | + uses: actions/cache@v3 |
20 | 24 | with: |
21 | | - path: ${{ steps.composer-cache.outputs.dir }} |
22 | | - # Use composer.json for key, if composer.lock is not committed. |
23 | | - # key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }} |
| 25 | + path: ~/.composer/cache |
24 | 26 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} |
25 | | - restore-keys: ${{ runner.os }}-composer- |
26 | | - - name: Install current dependencies from composer.lock |
27 | | - run: composer install |
28 | | - - name: Generate OpenAPI Specification JSON for REST API |
| 27 | + restore-keys: | |
| 28 | + ${{ runner.os }}-composer- |
| 29 | +
|
| 30 | + - name: Install Composer Dependencies |
| 31 | + run: composer install --no-interaction --prefer-dist |
| 32 | + |
| 33 | + - name: Generate OpenAPI Specification JSON |
29 | 34 | run: vendor/bin/openapi -o docs/latest-restapi.json --format json src |
30 | | - - name: Upload REST API(latest-restapi.json) Spec |
31 | | - uses: actions/upload-artifact@v2 |
| 35 | + |
| 36 | + - name: Upload REST API Specification |
| 37 | + uses: actions/upload-artifact@v3 |
32 | 38 | with: |
33 | 39 | name: restapi-json |
34 | 40 | path: docs/latest-restapi.json |
| 41 | + |
35 | 42 | deploy-docs: |
36 | | - name: Deploy REST API specification. |
| 43 | + name: Deploy REST API Specification |
37 | 44 | runs-on: ubuntu-20.04 |
38 | 45 | needs: make-restapi-docs |
39 | 46 | steps: |
40 | | - - name: Install node |
41 | | - uses: actions/setup-node@v2 |
42 | | - with: |
43 | | - node-version: '14' |
44 | | - - name: Install openapi-checker |
45 | | - run: npm install -g openapi-checker |
46 | | - - name: Checkout phplist/restapi-docs |
47 | | - uses: actions/checkout@v2 |
48 | | - with: |
49 | | - repository: phpList/restapi-docs |
50 | | - fetch-depth: 0 |
51 | | - token: ${{ secrets.PUSH_REST_API_DOCS }} |
52 | | - - name: Restore REST API Spec |
53 | | - uses: actions/download-artifact@v2 |
54 | | - with: |
55 | | - name: restapi-json |
56 | | - - name: Validate latest-restapi.json |
57 | | - run: openapi-checker latest-restapi.json |
58 | | - - name: Get difference between latest-restapi.json and restapi.json |
59 | | - # `|| true` to supress exit code 1 [git diff exits with 1 when there is a difference between the two files and 0 for the reverse. |
60 | | - run: git diff --no-index --output=restapi-diff.txt latest-restapi.json restapi.json || true |
61 | | - - name: Verify difference latest-restapi.json and restapi.json |
62 | | - id: allow-deploy |
63 | | - run: | |
64 | | - if [ -s restapi-diff.txt ]; then echo "Updates made to restapi.json deployment proceeding."; echo '::set-output name=DEPLOY::true'; else echo "No updates made to restapi.json deployment would be skipped."; echo '::set-output name=DEPLOY::false'; fi |
65 | | - - name: Commit and changes and deply |
66 | | - if: ${{ steps.allow-deploy.outputs.DEPLOY == 'true' }} |
67 | | - run: | |
68 | | - mv latest-restapi.json restapi.json |
69 | | - git config user.name "github-actions" |
70 | | - git config user.email "[email protected]" |
71 | | - git add restapi.json |
72 | | - git commit -s -m "phplist/rest-api docs deployment `date`" |
73 | | - git push |
| 47 | + - name: Setup Node.js |
| 48 | + uses: actions/setup-node@v3 |
| 49 | + with: |
| 50 | + node-version: 14 |
| 51 | + |
| 52 | + - name: Install openapi-checker |
| 53 | + run: npm install -g swagger-cli |
| 54 | + |
| 55 | + - name: Checkout REST API Docs Repository |
| 56 | + uses: actions/checkout@v3 |
| 57 | + with: |
| 58 | + repository: phpList/restapi-docs |
| 59 | + fetch-depth: 0 |
| 60 | + token: ${{ secrets.PUSH_REST_API_DOCS }} |
| 61 | + |
| 62 | + - name: Download Generated REST API Specification |
| 63 | + uses: actions/download-artifact@v3 |
| 64 | + with: |
| 65 | + name: restapi-json |
| 66 | + path: docs |
| 67 | + |
| 68 | + - name: Validate OpenAPI Specification |
| 69 | + run: swagger-cli validate docs/latest-restapi.json |
| 70 | + |
| 71 | + - name: Compare Specifications |
| 72 | + run: git diff --no-index --output=restapi-diff.txt docs/latest-restapi.json restapi.json || true |
| 73 | + |
| 74 | + - name: Check Differences and Decide Deployment |
| 75 | + id: allow-deploy |
| 76 | + run: | |
| 77 | + if [ -s restapi-diff.txt ]; then |
| 78 | + echo "Updates detected in the REST API specification. Proceeding with deployment."; |
| 79 | + echo 'DEPLOY=true' >> $GITHUB_ENV; |
| 80 | + else |
| 81 | + echo "No changes detected in the REST API specification. Skipping deployment."; |
| 82 | + echo 'DEPLOY=false' >> $GITHUB_ENV; |
| 83 | + fi |
| 84 | +
|
| 85 | + - name: Commit and Deploy Updates |
| 86 | + if: env.DEPLOY == 'true' |
| 87 | + run: | |
| 88 | + mv docs/latest-restapi.json docs/restapi.json |
| 89 | + git config user.name "github-actions" |
| 90 | + git config user.email "[email protected]" |
| 91 | + git add docs/restapi.json |
| 92 | + git commit -m "Update REST API documentation `date`" |
| 93 | + git push |
0 commit comments