-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Note: There are no changes to the code in this release. Added - Github CI Workflows. - Github security reporting Updated - Code updated to latest Moodle coding guidelines. - Bug reporting form. - Tested compatible and tested with Moodle 3.9, 3.10, 3.11, 4.0, 4.1, 4.2, 4.3 and 4.4. - Compatible with Moodle up to v4.4. - Updated copyright notice for 2024.
- Loading branch information
1 parent
51a2ff2
commit 0db8601
Showing
32 changed files
with
617 additions
and
164 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| # Runs tests and code analysis. | ||
| # Based on: | ||
| # https://github.com/moodlehq/moodle-plugin-ci/blob/main/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.6.7 | ||
| 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, builds will be created in | ||
| # total (7.4-pgsql, 7.4-mariadb, 8.0-pgsql, 8.0-mariadb, etc.). | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| # Next version of Moodle (main). | ||
| # - php: '8.3' | ||
| # moodle-branch: 'main' | ||
| # database: 'pgsql' | ||
| # - php: '8.3' | ||
| # moodle-branch: 'main' | ||
| # database: 'mariadb' | ||
| # - php: '8.2' | ||
| # moodle-branch: 'main' | ||
| # database: 'mariadb' | ||
| # Moodle 4.4.x (MOODLE_404_STABLE). | ||
| - php: '8.3' | ||
| moodle-branch: 'MOODLE_404_STABLE' | ||
| database: 'pgsql' | ||
| - php: '8.3' | ||
| moodle-branch: 'MOODLE_404_STABLE' | ||
| database: 'mariadb' | ||
| - php: '8.2' | ||
| moodle-branch: 'MOODLE_404_STABLE' | ||
| database: 'mariadb' | ||
| - php: '8.1' | ||
| moodle-branch: 'MOODLE_404_STABLE' | ||
| database: 'pgsql' | ||
| # Moodle 4.3.x (MOODLE_403_STABLE). | ||
| - php: '8.2' | ||
| moodle-branch: 'MOODLE_403_STABLE' | ||
| database: 'pgsql' | ||
| - php: '8.0' | ||
| moodle-branch: 'MOODLE_403_STABLE' | ||
| database: 'mariadb' | ||
| # Moodle 4.2.x (MOODLE_402_STABLE). | ||
| - php: '8.2' | ||
| moodle-branch: 'MOODLE_402_STABLE' | ||
| database: 'mariadb' | ||
| - php: '8.0' | ||
| moodle-branch: 'MOODLE_402_STABLE' | ||
| database: 'pgsql' | ||
| # Moodle 4.1.x (MOODLE_401_STABLE). | ||
| - php: '8.1' | ||
| moodle-branch: 'MOODLE_401_STABLE' | ||
| database: 'pgsql' | ||
| - php: '7.4' | ||
| moodle-branch: 'MOODLE_401_STABLE' | ||
| database: 'mariadb' | ||
|
|
||
| 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=6000 | ||
| # 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: pcov | ||
|
|
||
| # 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 | ||
| continue-on-error: true # This step will show errors but will not fail | ||
| if: ${{ !cancelled() }} | ||
| run: moodle-plugin-ci validate | ||
|
|
||
| - name: Check upgrade savepoints | ||
| if: ${{ !cancelled() }} | ||
| run: moodle-plugin-ci savepoints | ||
|
|
||
| # This plugin does not use Mustache templates. | ||
| # - name: Mustache Lint | ||
| # if: ${{ !cancelled() }} | ||
| # run: moodle-plugin-ci mustache | ||
|
|
||
| - name: Grunt | ||
| continue-on-error: true # This step will show errors but will not fail | ||
| if: ${{ !cancelled() }} | ||
| run: moodle-plugin-ci grunt --max-lint-warnings 0 | ||
|
|
||
| - name: PHPUnit tests | ||
| continue-on-error: true # This step will show errors but will not fail | ||
| 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 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,6 +103,9 @@ test.php | |
| *.tmp | ||
| *.temp | ||
|
|
||
| ##### Git Patches | ||
| *.patch | ||
|
|
||
| ##### GPG | ||
| secring.* | ||
|
|
||
|
|
||
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
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
File renamed without changes.
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
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
Oops, something went wrong.