Documentation #10
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: Documentation | |
| on: | |
| pull_request: | |
| paths: | |
| - '.github/workflows/**' | |
| - 'appinfo/**' | |
| - 'lib/**' | |
| - 'templates/**' | |
| - 'tests/**' | |
| - 'vendor/**' | |
| - 'vendor-bin/**' | |
| - '.php-cs-fixer.dist.php' | |
| - 'composer.json' | |
| - 'composer.lock' | |
| push: | |
| branches: | |
| - main | |
| - master | |
| - stable* | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: occ-commands-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| occ-commands: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| php-versions: ['8.1'] | |
| server-versions: ['stable27'] | |
| steps: | |
| - name: Set app env | |
| run: | | |
| # Split and keep last | |
| echo "APP_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV | |
| - name: Checkout server | |
| uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | |
| with: | |
| submodules: true | |
| repository: nextcloud/server | |
| ref: ${{ matrix.server-versions }} | |
| - name: Checkout app | |
| uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | |
| with: | |
| path: apps/${{ env.APP_NAME }} | |
| - name: Set up php ${{ matrix.php-versions }} | |
| uses: shivammathur/setup-php@c5fc0d8281aba02c7fda07d3a70cc5371548067d # v2 | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| # https://docs.nextcloud.com/server/stable/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation | |
| extensions: bz2, ctype, curl, dom, fileinfo, gd, iconv, intl, json, libxml, mbstring, openssl, pcntl, posix, session, simplexml, xmlreader, xmlwriter, zip, zlib, sqlite, pdo_sqlite | |
| coverage: none | |
| ini-file: development | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Check composer file existence | |
| id: check_composer | |
| uses: andstor/file-existence-action@20b4d2e596410855db8f9ca21e96fbe18e12930b # v2 | |
| with: | |
| files: apps/${{ env.APP_NAME }}/composer.json | |
| - name: Set up dependencies | |
| # Only run if phpunit config file exists | |
| if: steps.check_composer.outputs.files_exists == 'true' | |
| working-directory: apps/${{ env.APP_NAME }} | |
| run: composer i | |
| - name: Set up Nextcloud | |
| env: | |
| DB_PORT: 4444 | |
| run: | | |
| mkdir data | |
| ./occ maintenance:install --verbose --database=sqlite --database-name=nextcloud --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=root --database-pass=rootpassword --admin-user admin --admin-pass admin | |
| ./occ app:enable ${{ env.APP_NAME }} | |
| ./occ config:system:set debug --value true --type boolean | |
| - name: Check if documentation is up to date | |
| id: check_documentation | |
| run: | | |
| ./occ talk:developer:update-docs | |
| cd apps/${{ env.APP_NAME }} | |
| bash -c "[[ ! \"`git status --porcelain `\" ]] || (cat docs/occ.md && echo 'Documentation outdated. Run the command talk:developer:update-docs locally, commit the occ.md file and push the changes.' && exit 1)" |