From cb1f8b5a0aaf1bde6b97fd462c0e8742dc2c7660 Mon Sep 17 00:00:00 2001 From: Michael Milette Date: Sun, 14 Apr 2024 14:47:10 -0400 Subject: [PATCH] Added github actions workflow. --- .github/workflows/moodle-plugin-ci.yml | 223 +++++++++++++++++++++++++ CHANGELOG.md | 2 + 2 files changed, 225 insertions(+) create mode 100644 .github/workflows/moodle-plugin-ci.yml diff --git a/.github/workflows/moodle-plugin-ci.yml b/.github/workflows/moodle-plugin-ci.yml new file mode 100644 index 0000000..c044be6 --- /dev/null +++ b/.github/workflows/moodle-plugin-ci.yml @@ -0,0 +1,223 @@ +# Upstream for this Action is availble at +# https://github.com/moodlehq/moodle-plugin-ci/blob/master/gha.dist.yml + +# Title of the workflow +name: Moodle Plugin CI + +# Run this workflow every time a new commit pushed to your repository or PR created. +on: [push, pull_request] + +# Give just enough permissions to fetch code (actions/checkout). +permissions: + contents: read + +jobs: + # Set the job key. The key is displayed as the job name when a job name is not provided + test: + # Virtual environment to use. + runs-on: ubuntu-22.04 + + # DB services you need for testing. + 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 + + # Determines build matrix. This is a list of PHP versions, databases and + # branches to test our project against. For each combination a separate + # build will be created. For example below 6 builds will be created in + # total (7.4-pgsql, 7.4-mariadb, 8.0-pgsql, 8.0-mariadb, etc.). If we add + # another branch, total number of builds will become 12. + strategy: + fail-fast: false + matrix: + php: ['7.4', '8.0', '8.1', '8.2'] + moodle-branch: ['MOODLE_401_STABLE', 'MOODLE_402_STABLE', 'MOODLE_403_STABLE', 'master'] + database: [pgsql, mariadb] + include: + # Only Moodle 4.2, 4.3 and master support PHP 8.2. + - moodle-branch: 'MOODLE_403_STABLE' + php: '8.2' + database: 'mariadb' + - moodle-branch: 'MOODLE_403_STABLE' + php: '8.2' + database: 'pgsql' + - moodle-branch: 'MOODLE_402_STABLE' + php: '8.2' + database: 'mariadb' + - moodle-branch: 'MOODLE_402_STABLE' + php: '8.2' + database: 'pgsql' + - moodle-branch: 'master' + php: '8.2' + database: 'mariadb' + - moodle-branch: 'master' + php: '8.2' + database: 'pgsql' + exclude: + # Moodle 4.2, 4.3 and master do not support PHP 7.4. + - moodle-branch: 'MOODLE_403_STABLE' + php: '7.4' + - moodle-branch: 'MOODLE_402_STABLE' + php: '7.4' + - moodle-branch: 'master' + php: '7.4' + # master does not support 8.0. + - moodle-branch: 'master' + php: '8.0' + + # There is an alternative way allowing to define explicitly define which php, moodle-branch and database to use: + # + # matrix: + # include: + # - php: '8.0' + # moodle-branch: 'MOODLE_401_STABLE' + # database: pgsql + # - php: '8.0' + # moodle-branch: 'MOODLE_400_STABLE' + # database: mariadb + # - php: '7.4' + # moodle-branch: 'MOODLE_311_STABLE' + # database: pgsql + + steps: + # Check out this repository code in ./plugin directory + - name: Check out repository code + uses: actions/checkout@v4 + with: + path: plugin + + # Install PHP of required version. For possible options see https://github.com/shivammathur/setup-php + - name: Setup PHP ${{ matrix.php }} + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: ${{ matrix.extensions }} + ini-values: max_input_vars=5000 + # If you are not using code coverage, keep "none". Otherwise, use "pcov" (Moodle 3.10 and up) or "xdebug". + # If you try to use code coverage with "none", it will fallback to phpdbg (which has known problems). + coverage: none + + # Install this project into a directory called "ci", updating PATH and locale, define nvm location. + - 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 + + # Run the default install. + # Optionally, it is possible to specify a different Moodle repo to use + # (https://github.com/moodle/moodle.git is used by default) and define + # ignore directives or any other env vars for install step. For more + # details on configuring for specific requirements please refer to the + # 'Help' page. + # + # env: + # MOODLE_REPO=https://github.com/username/moodle.git + # IGNORE_PATHS: 'ignore' + # IGNORE_NAMES: 'ignore_name.php' + # MUSTACHE_IGNORE_NAMES: 'broken.mustache' + # CODECHECKER_IGNORE_PATHS: 'ignoreme' + # CODECHECKER_IGNORE_NAMES: 'ignoreme_name.php' + # + # Other env vars are available for install, namely: + # - DB_USER / DB_PASS / DB_NAME / DB_HOST / DB_PORT: used + # by install to feed the corresponding --db-xxxx options. + # - MOODLE_APP: used to install dependencies to run Behat tests + # using the Moodle App. + - 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 }} + # Uncomment this to run Behat tests using the Moodle App. + # MOODLE_APP: 'true' + + # Steps that are run for the purpose of testing. Any of these steps + # can be re-ordered or removed to your liking. And of course, you can + # add any of your own custom steps. + - name: PHP Lint + continue-on-error: true # This step will show errors but will not fail + if: ${{ !cancelled() }} + run: moodle-plugin-ci phplint + + - name: PHP Copy/Paste Detector + continue-on-error: true # This step will show errors but will not fail + if: ${{ !cancelled() }} + run: moodle-plugin-ci phpcpd + + - 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 + continue-on-error: true # This step will show errors but will not fail + if: ${{ !cancelled() }} + run: moodle-plugin-ci phpcs --max-warnings 0 + + - name: Moodle PHPDoc Checker + continue-on-error: true # This step will show errors but will not fail + if: ${{ !cancelled() }} + run: moodle-plugin-ci phpdoc --max-warnings 0 + + - name: Validating + if: ${{ !cancelled() }} + run: moodle-plugin-ci validate + + # This plugin does not use Mustache templates. + # - name: Mustache Lint + # if: ${{ !cancelled() }} + # run: moodle-plugin-ci mustache + + - name: Check upgrade savepoints + if: ${{ !cancelled() }} + run: moodle-plugin-ci savepoints + + - name: Grunt + if: ${{ !cancelled() }} + run: moodle-plugin-ci grunt --max-lint-warnings 0 + + - name: PHPUnit tests + if: ${{ !cancelled() }} + run: moodle-plugin-ci phpunit --fail-on-warning + + # - name: Behat features + # id: behat + # if: ${{ !cancelled() }} + # run: moodle-plugin-ci behat --profile chrome + + # This step allows to upload Behat faildump (screenshots) as workflow artifact + # so it can be downloaded and inspected. You don't need this step if you + # are not running Behat test. Artifact will be retained for 7 days. + + # - name: Upload Behat Faildump + # if: ${{ failure() && steps.behat.outcome == 'failure' }} + # uses: actions/upload-artifact@v4 + # with: + # name: Behat Faildump (${{ join(matrix.*, ', ') }}) + # path: ${{ github.workspace }}/moodledata/behat_dump + # retention-days: 7 + # if-no-files-found: ignore + + - name: Mark cancelled jobs as failed. + if: ${{ cancelled() }} + run: exit 1 diff --git a/CHANGELOG.md b/CHANGELOG.md index 213cacc..b4eeaf9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file. - New {ifnottheme}{/ifnottheme} tag. - New {alert border}{/alert} tag. - New links to edit Advanced theme settings and current theme settings to {menuthemes} tag. +- GitHub actions workflow. ### Updated - Fix-291: Escape tags now work reliably. - Improved filtering of parameters for some tags. @@ -17,6 +18,7 @@ All notable changes to this project will be documented in this file. - {getstring} tag now checks if string is deprecated before trying to load a string from the language pack. - Reference to style guides in CONTRIBUTING.md. - References to PHP and Noodle versions in bug reports. +- Removed support for Travis integration. - Fixed compatibility issue with Moodle LMS 4.4 (ALPHA) - Copyright notice to include 2024.