Fix phpdocs for param #34
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: Moodle Plugin CI | |
| on: [push, pull_request] | |
| jobs: | |
| test: | |
| runs-on: ubuntu-22.04 | |
| services: | |
| postgres: | |
| image: postgres:13 | |
| env: | |
| POSTGRES_USER: 'postgres' | |
| POSTGRES_HOST_AUTH_METHOD: 'trust' | |
| ports: | |
| - 5432:5432 | |
| options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3 | |
| mariadb: | |
| image: mariadb:10 | |
| env: | |
| MYSQL_USER: 'root' | |
| MYSQL_ALLOW_EMPTY_PASSWORD: "true" | |
| MYSQL_CHARACTER_SET_SERVER: "utf8mb4" | |
| MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci" | |
| ports: | |
| - 3306:3306 | |
| options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - php: '8.2' | |
| moodle-branch: 'MOODLE_403_STABLE' | |
| database: 'mariadb' | |
| - php: '8.1' | |
| moodle-branch: 'MOODLE_401_STABLE' | |
| database: 'mariadb' | |
| steps: | |
| - name: Check out repository code | |
| uses: actions/checkout@v4 | |
| with: | |
| path: plugin | |
| - name: Setup PHP ${{ matrix.php }} | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| extensions: ${{ matrix.extensions }} | |
| ini-values: max_input_vars=5000 | |
| # none to use phpdbg fallback. Specify pcov (Moodle 3.10 and up) or xdebug to use them instead. | |
| coverage: none | |
| - name: Initialise moodle-plugin-ci | |
| run: | | |
| composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4 | |
| echo $(cd ci/bin; pwd) >> $GITHUB_PATH | |
| echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH | |
| sudo locale-gen en_AU.UTF-8 | |
| echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV | |
| - name: Install moodle-plugin-ci | |
| run: | | |
| moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1 | |
| env: | |
| DB: ${{ matrix.database }} | |
| MOODLE_BRANCH: ${{ matrix.moodle-branch }} | |
| IGNORE_PATHS: 'samples' | |
| GRUNT_IGNORE_NAMES: 'styles.css' | |
| - name: PHP Lint | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci phplint | |
| - name: PHP Mess Detector | |
| continue-on-error: true # This step will show errors but will not fail | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci phpmd | |
| - name: Moodle Code Checker | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci phpcs --max-warnings 0 | |
| - name: Moodle PHPDoc Checker | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci phpdoc --max-warnings 0 | |
| - name: Validating | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci validate | |
| - name: Check upgrade savepoints | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci savepoints | |
| - name: Mustache Lint | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci mustache | |
| - name: Grunt | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci grunt -t amd -t gherkinlint -t stylelint | |
| - name: PHPUnit tests | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci phpunit --fail-on-warning | |
| - name: Behat features | |
| if: ${{ !cancelled() }} | |
| run: moodle-plugin-ci behat --profile chrome | |
| - name: Mark cancelled jobs as failed. | |
| if: ${{ cancelled() }} | |
| run: exit 1 |