Update for Moodle 5.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,53 @@
+> **Note:** Please fill out all required sections and remove irrelevant ones.
+### 🔀 Purpose of this PR:
+
+- [ ] Fixes a bug
+- [ ] Updates for a new Moodle version
+- [ ] Adds a new feature of functionality
+- [ ] Improves or enhances existing features
+- [ ] Refactoring: restructures code for better performance or maintainability
+- [ ] Testing: add missing or improve existing tests
+- [ ] Miscellaneous: code cleaning (without functional changes), documentation, configuration, ...
+
+---
+
+### 📝 Description:
+
+Please describe the purpose of this PR in a few sentences.
+
+- What feature or bug does it address?
+- Why is this change or addition necessary?
+- What is the expected behavior after the change?
+
+---
+
+### 📋 Checklist
+
+Please confirm the following (check all that apply):
+
+- [ ] I have `phpunit` and/or `behat` tests that cover my changes or additions.
+- [ ] Code passes the code checker without errors and warnings.
+- [ ] Code passes the moodle-ci/cd pipeline on all supported Moodle versions or the ones the plugin supports.
+- [ ] Code does not have `var_dump()` or `var_export` or any other debugging statements (or commented out code) that
+  should not appear on the productive branch.
+- [ ] Code only uses language strings instead of hard-coded strings.
+- [ ] If there are changes in the database: I updated/created the necessary upgrade steps in `db/upgrade.php` and
+  updated the `version.php`.
+- [ ] If there are changes in javascript: I build new `.min` files with the `grunt amd` command.
+- [ ] If it is a Moodle update PR: I read the release notes, updated the `version.php` and the `CHANGES.md`.
+  I ran all tests thoroughly checking for errors. I checked if bootstrap had any changes/deprecations that require
+  changes in the plugins UI.
+
+---
+
+### 🔍 Related Issues
+
+- Related to #[IssueNumber]
+
+---
+
+### 🧾📸🌐 Additional Information (like screenshots, documentation, links, etc.)
+
+Any other relevant information.
+
+---

.github/workflows/config.json

@@ -0,0 +1,22 @@
+{
+  "moodle-plugin-ci": "4.5.7",
+  "main-moodle": "MOODLE_500_STABLE",
+  "main-php": "8.3",
+  "main-db": "pgsql",
+  "moodle-testmatrix": {
+    "MOODLE_401_STABLE": {
+      "php": ["8.0", "8.1"]
+    },
+    "MOODLE_404_STABLE": {
+      "php": ["8.1", "8.2", "8.3"]
+    },
+    "MOODLE_405_STABLE": {
+      "php": ["8.1", "8.2", "8.3"],
+      "db": ["pgsql", "mariadb", "mysqli"]
+    },
+    "MOODLE_500_STABLE": {
+      "php": ["8.2", "8.3", "8.4"],
+      "db": ["pgsql", "mariadb", "mysqli"]
+    }
+  }
+}

.github/workflows/moodle-ci.yml

@@ -1,210 +1,9 @@
 name: Moodle Plugin CI
-
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
-  static:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        php: ['8.3']
-        moodle-branch: ['MOODLE_405_STABLE']
-        database: ['pgsql']
-
-    steps:
-      - name: Start PostgreSQL
-        run: docker run -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_HOST_AUTH_METHOD=trust -d postgres:14
-
-      - name: Check out repository code
-        uses: actions/checkout@v3
-        with:
-          path: plugin
-
-      - name: Setup PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          ini-values: max_input_vars=5000
-          coverage: none
-
-      - name: Get composer cache directory
-        id: composer-cache
-        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-
-      - name: Composer cache
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-composer-
-
-      - name: npm cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Initialise moodle-plugin-ci
-        run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci 4.5.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 mod plugin
-        run: moodle-plugin-ci add-plugin learnweb/moodle-mod_moodleoverflow
-
-      - name: Install local plugin
-        run: moodle-plugin-ci add-plugin learnweb/moodle-local_townsquaresupport
-
-      - name: Install townsquareexpansion plugin
-        run: moodle-plugin-ci add-plugin learnweb/moodle-townsquareexpansion_moodleoverflow
-
-      - name: Install townsquareexpansion plugin
-        run: moodle-plugin-ci add-plugin learnweb/moodle-townsquareexpansion_ratingallocate
-
-      - name: Install townsquareexpansion plugin
-        run: moodle-plugin-ci add-plugin learnweb/moodle-townsquareexpansion_zoom
-
-      - name: Install moodle-plugin-ci
-        run: |
-          moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1 --no-init
-        env:
-          DB: ${{ matrix.database }}
-          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
-
-      - name: PHP Lint
-        if: ${{ always() }}
-        run: moodle-plugin-ci phplint
-
-      - name: PHP Copy/Paste Detector
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpcpd
-        continue-on-error: true
-
-      - name: PHP Mess Detector
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpmd
-
-      - name: Moodle Code Checker
-        if: ${{ always() }}
-        run: moodle-plugin-ci codechecker
-
-      - name: Moodle PHPDoc Checker
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpdoc
-        continue-on-error: true
-
-      - name: Validating
-        if: ${{ always() }}
-        run: moodle-plugin-ci validate
-
-      - name: Check upgrade savepoints
-        if: ${{ always() }}
-        run: moodle-plugin-ci savepoints
-
-      - name: Mustache Lint
-        if: ${{ always() }}
-        run: moodle-plugin-ci mustache
-        continue-on-error: true
-
-      - name: Grunt
-        if: ${{ always() }}
-        run: moodle-plugin-ci grunt
-        continue-on-error: true
-
-  test:
-    runs-on: ubuntu-latest
-    needs: static
-
-    strategy:
-      fail-fast: false
-      matrix:
-        php: [ '8.0', '8.1', '8.2', '8.3' ]
-        moodle-branch: [ 'MOODLE_401_STABLE', 'MOODLE_403_STABLE', 'MOODLE_404_STABLE','MOODLE_405_STABLE' ]
-        database: [ 'mariadb', 'pgsql' ]
-        exclude:
-          - php: '8.0'
-            moodle-branch: 'MOODLE_404_STABLE'
-          - php: '8.0'
-            moodle-branch: 'MOODLE_405_STABLE'
-          - php: '8.2'
-            moodle-branch: 'MOODLE_401_STABLE'
-          - php: '8.3'
-            moodle-branch: 'MOODLE_401_STABLE'
-          - php: '8.3'
-            moodle-branch: 'MOODLE_403_STABLE'
-        include:
-          - php: '7.4'
-            moodle-branch: 'MOODLE_401_STABLE'
-            database: 'pgsql'
-          - php: '7.4'
-            moodle-branch: 'MOODLE_401_STABLE'
-            database: 'mariadb'
-
-    steps:
-      - name: Start MariaDB
-        if: matrix.database == 'mariadb'
-        run: docker run -p 3306:3306 -e MYSQL_USER=root -e MYSQL_ALLOW_EMPTY_PASSWORD=true -d mariadb:10
-
-      - name: Start PostgreSQL
-        if: matrix.database == 'pgsql'
-        run: docker run -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_HOST_AUTH_METHOD=trust -d postgres:14
-
-      - name: Check out repository code
-        uses: actions/checkout@v3
-        with:
-          path: plugin
-
-      - name: Setup PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          ini-values: max_input_vars=5000
-          coverage: none
-
-      - name: Get composer cache directory
-        id: composer-cache
-        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-      - name: Composer cache
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-composer-
-      - name: npm cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Initialise moodle-plugin-ci
-        run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci 4.5.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 }}
-
-      - name: PHPUnit tests
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpunit
-
-      - name: Behat features
-        if: ${{ always() }}
-        run: moodle-plugin-ci behat --auto-rerun 0
+  call:
+    name: ""
+    uses: learnweb/moodle-workflows-learnweb/.github/workflows/moodle-ci.yml@main
+    with:
+      allow-mustache-lint-error: true

.github/workflows/moodle-release.yml

@@ -1,54 +1,12 @@
-#
-# Whenever a new tag starting with "v" is pushed, add the tagged version
-# to the Moodle Plugins directory at https://moodle.org/plugins
-#
-# revision: 2021070201
-# Changed to be released on Github release with the release notes.
-#
-name: Releasing in the Plugins directory
+name: Moodle Plugin Release
 
 on:
   release:
-    types: [published]
-
-defaults:
-  run:
-    shell: bash
+    types: [ published ]
 
 jobs:
-  release-at-moodle-org:
-    runs-on: ubuntu-latest
-    env:
-      PLUGIN: blocks_townsquare
-      CURL: curl -s
-      ENDPOINT: https://moodle.org/webservice/rest/server.php
-      TOKEN: ${{ secrets.MOODLE_ORG_TOKEN }}
-      FUNCTION: local_plugins_add_version
-
-    steps:
-      - name: Call the service function
-        id: add-version
-        run: |
-          TAGNAME="${{ github.event.release.tag_name }}"
-          BODY="${{ github.event.release.body }}"
-          ZIPURL="${{ github.event.release.zipball_url }}"
-          RESPONSE=$(${CURL} ${ENDPOINT} --data-urlencode "wstoken=${TOKEN}" \
-                                         --data-urlencode "wsfunction=${FUNCTION}" \
-                                         --data-urlencode "moodlewsrestformat=json" \
-                                         --data-urlencode "frankenstyle=${PLUGIN}" \
-                                         --data-urlencode "zipurl=${ZIPURL}" \
-                                         --data-urlencode "vcssystem=git" \
-                                         --data-urlencode "vcsrepositoryurl=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" \
-                                         --data-urlencode "vcstag=${TAGNAME}" \
-                                         --data-urlencode "changelogurl=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commits/${TAGNAME}" \
-                                         --data-urlencode "altdownloadurl=${ZIPURL}" \
-                                         --data-urlencode "releasenotes=${BODY}" \
-                                         --data-urlencode "releasenotesformat=4")
-          echo "response=${RESPONSE}" >> $GITHUB_OUTPUT
-      - name: Evaluate the response
-        id: evaluate-response
-        env:
-          RESPONSE: ${{ steps.add-version.outputs.response }}
-        run: |
-          jq <<< ${RESPONSE}
-          jq --exit-status ".id" <<< ${RESPONSE} > /dev/null
+  call-moodle-release-workflow:
+    uses: learnweb/moodle-workflows-learnweb/.github/workflows/moodle-release.yml@main
+    with:
+      plugin-name: 'block_townsquare'
+    secrets: inherit

CHANGES.md

@@ -0,0 +1,8 @@
+CHANGELOG
+=========
+
+v5.0-r1 (2025-06-24)
+------------------
+- Update for Moodle 5.0
+- Update UI with new bootstrap classes, keep old-UI compatibility for older Moodle versions
+- Improve language strings in sidepanel