Merge branch 'minor-next' into bootstrap-exit-warnings

.github/PULL_REQUEST_TEMPLATE.md

@@ -34,7 +34,10 @@ Requires translations:
 
 ## Tests
 <!--
-Details should be provided of tests done. Simply saying "tested" or equivalent is not acceptable.
-
-Attach scripts or actions to test this pull request, as well as the result
+PRs which have not been tested MUST be marked as draft.
 -->
+I tested this PR by doing the following (tick all that apply):
+- [ ] Writing PHPUnit tests (commit these in the `tests/phpunit` folder)
+- [ ] Playtesting using a Minecraft client (provide screenshots or a video)
+- [ ] Writing a test plugin (provide the code and sample output)
+- [ ] Other (provide details)

.github/dependabot.yml

@@ -3,11 +3,38 @@ updates:
 - package-ecosystem: composer
   directory: "/"
   schedule:
-    interval: daily
+    interval: weekly
     time: "10:00"
   open-pull-requests-limit: 10
+  ignore:
+    #only allow patch updates for locale-data - this has to be updated manually due to codegen
+    - dependency-name: pocketmine/locale-data
+      update-types:
+        - "version-update:semver-major"
+        - "version-update:semver-minor"
+  groups:
+    production-patch-updates:
+      dependency-type: production
+      patterns:
+        - "*"
+      update-types:
+        - "patch"
+    development-patch-updates:
+      dependency-type: development
+      patterns:
+        - "*"
+      update-types:
+        - "patch"
+    phpstan:
+      patterns:
+        - "phpstan/*"
 
 - package-ecosystem: gitsubmodule
   directory: "/"
   schedule:
     interval: daily
+
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly

.github/workflows/build-docker-image.yml

@@ -12,16 +12,23 @@ jobs:
 
     steps:
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Clone pmmp/PocketMine-Docker repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: pmmp/PocketMine-Docker
           fetch-depth: 1
@@ -30,68 +37,68 @@ jobs:
         id: tag-name
         run: |
           VERSION=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{')
-          echo ::set-output name=TAG_NAME::$VERSION
-          echo ::set-output name=MAJOR::$(echo $VERSION | cut -d. -f1)
-          echo ::set-output name=MINOR::$(echo $VERSION | cut -d. -f1-2)
+          echo TAG_NAME=$VERSION >> $GITHUB_OUTPUT
+          echo MAJOR=$(echo $VERSION | cut -d. -f1) >> $GITHUB_OUTPUT
+          echo MINOR=$(echo $VERSION | cut -d. -f1-2) >> $GITHUB_OUTPUT
 
       - name: Download new release information
         run: curl -f -L ${{ github.server_url }}/${{ github.repository }}/releases/download/${{ steps.tag-name.outputs.TAG_NAME }}/build_info.json -o new_build_info.json
 
       - name: Detect channel
         id: channel
-        run: echo ::set-output name=CHANNEL::$(jq -r '.channel' new_build_info.json)
+        run: echo CHANNEL=$(jq -r '.channel' new_build_info.json) >> $GITHUB_OUTPUT
 
       - name: Get name of Docker repository name
         id: docker-repo-name
-        run: echo ::set-output name=NAME::$(echo "${GITHUB_REPOSITORY,,}")
+        run: echo NAME=$(echo "${GITHUB_REPOSITORY,,}") >> $GITHUB_OUTPUT
 
       - name: Build image for tag
-        uses: docker/build-push-action@v2.10.0
+        uses: docker/build-push-action@v6.9.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}
 
       - name: Build image for major tag
         if: steps.channel.outputs.CHANNEL == 'stable'
-        uses: docker/build-push-action@v2.10.0
+        uses: docker/build-push-action@v6.9.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}
 
       - name: Build image for minor tag
         if: steps.channel.outputs.CHANNEL == 'stable'
-        uses: docker/build-push-action@v2.10.0
+        uses: docker/build-push-action@v6.9.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}
 
       - name: Build image for latest tag
         if: steps.channel.outputs.CHANNEL == 'stable'
-        uses: docker/build-push-action@v2.10.0
+        uses: docker/build-push-action@v6.9.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:latest
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:latest
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:latest
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}

.github/workflows/discord-release-embed.php

@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types=1);
+
+namespace pocketmine;
+
+use pocketmine\utils\Internet;
+use function dirname;
+use function fwrite;
+use function is_array;
+use function json_decode;
+use function json_encode;
+use const JSON_THROW_ON_ERROR;
+use const STDERR;
+
+require dirname(__DIR__, 2) . '/vendor/autoload.php';
+
+/**
+ * @phpstan-return array<string, mixed>
+ */
+function generateDiscordEmbed(string $version, string $channel, string $description, string $detailsUrl, string $sourceUrl, string $pharDownloadUrl, string $buildLogUrl, int $newsPingRoleId, ?string $phpDownloadUrl) : array{
+	if($phpDownloadUrl !== null){
+		$phpEmbedLink = " | [PHP Binaries]($phpDownloadUrl)";
+	}else{
+		$phpEmbedLink = "";
+	}
+	return [
+		"content" => "<@&$newsPingRoleId> New PocketMine-MP release: $version ($channel)",
+		"embeds" => [
+			[
+				"title" => "New PocketMine-MP release: $version ($channel)",
+				"description" => <<<DESCRIPTION
+$description
+
+[Details]($detailsUrl) | [Source Code]($sourceUrl) | [Build Log]($buildLogUrl) | [Download]($pharDownloadUrl)$phpEmbedLink
+DESCRIPTION,
+				"url" => $detailsUrl,
+				"color" => $channel === "stable" ? 0x57ab5a : 0xc69026
+			]
+		]
+	];
+}
+
+if(count($argv) !== 6){
+	fwrite(STDERR, "Required arguments: github repo, version, API token, webhook URL, ping role ID\n");
+	exit(1);
+}
+[, $repo, $tagName, $token, $hookURL, $newsPingRoleId] = $argv;
+
+$result = Internet::getURL('https://api.github.com/repos/' . $repo . '/releases/tags/' . $tagName, extraHeaders: [
+	'Authorization: token ' . $token
+]);
+if($result === null){
+	fwrite(STDERR, "failed to access GitHub API\n");
+	return;
+}
+if($result->getCode() !== 200){
+	fwrite(STDERR, "Error accessing GitHub API: " . $result->getCode() . "\n");
+	fwrite(STDERR, $result->getBody() . "\n");
+	exit(1);
+}
+
+$releaseInfoJson = json_decode($result->getBody(), true, JSON_THROW_ON_ERROR);
+if(!is_array($releaseInfoJson)){
+	fwrite(STDERR, "Invalid release JSON returned from GitHub API\n");
+	exit(1);
+}
+$buildInfoPath = 'https://github.com/' . $repo . '/releases/download/' . $tagName . '/build_info.json';
+
+$buildInfoResult = Internet::getURL($buildInfoPath, extraHeaders: [
+	'Authorization: token ' . $token
+]);
+if($buildInfoResult === null){
+	fwrite(STDERR, "missing build_info.json\n");
+	exit(1);
+}
+if($buildInfoResult->getCode() !== 200){
+	fwrite(STDERR, "error accessing build_info.json: " . $buildInfoResult->getCode() . "\n");
+	fwrite(STDERR, $buildInfoResult->getBody() . "\n");
+	exit(1);
+}
+
+$buildInfoJson = json_decode($buildInfoResult->getBody(), true, JSON_THROW_ON_ERROR);
+if(!is_array($buildInfoJson)){
+	fwrite(STDERR, "invalid build_info.json\n");
+	exit(1);
+}
+$detailsUrl = $buildInfoJson["details_url"];
+$sourceUrl = $buildInfoJson["source_url"];
+$pharDownloadUrl = $buildInfoJson["download_url"];
+$buildLogUrl = $buildInfoJson["build_log_url"];
+$phpBinaryUrl = $buildInfoJson["php_download_url"] ?? null;
+
+$description = $releaseInfoJson["body"];
+
+$discordPayload = generateDiscordEmbed(
+	$buildInfoJson["base_version"],
+	$buildInfoJson["channel"],
+	$description,
+	$detailsUrl,
+	$sourceUrl,
+	$pharDownloadUrl,
+	$buildLogUrl,
+	(int) $newsPingRoleId,
+	$phpBinaryUrl
+);
+
+$response = Internet::postURL(
+	$hookURL,
+	json_encode($discordPayload, JSON_THROW_ON_ERROR),
+	extraHeaders: ['Content-Type: application/json']
+);
+if($response?->getCode() !== 204){
+	fwrite(STDERR, "failed to send Discord webhook\n");
+	fwrite(STDERR, $response?->getBody() ?? "no response body\n");
+	exit(1);
+}

.github/workflows/discord-release-notify.yml

@@ -0,0 +1,38 @@
+name: Notify Discord webhook of release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP and tools
+        uses: shivammathur/setup-php@2.31.1
+        with:
+          php-version: 8.2
+
+      - name: Restore Composer package cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/composer/files
+            ~/.cache/composer/vcs
+          key: "composer-v2-cache-${{ hashFiles('./composer.lock') }}"
+          restore-keys: |
+            composer-v2-cache-
+
+      - name: Install Composer dependencies
+        run: composer install --no-dev --prefer-dist --no-interaction --ignore-platform-reqs
+
+      - name: Get actual tag name
+        id: tag-name
+        run: echo TAG_NAME=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{') >> $GITHUB_OUTPUT
+
+      - name: Run webhook post script
+        run: php .github/workflows/discord-release-embed.php ${{ github.repository }} ${{ steps.tag-name.outputs.TAG_NAME }} ${{ github.token }} ${{ secrets.DISCORD_RELEASE_WEBHOOK }} ${{ secrets.DISCORD_NEWS_PING_ROLE_ID }}

.github/workflows/draft-release-from-pr.yml

@@ -0,0 +1,65 @@
+name: Draft release from PR
+
+on:
+  #presume that pull_request_target is safe at this point, since the PR was approved and merged
+  #we need write access to prepare the release & create comments
+  pull_request_target:
+    types:
+      - closed
+    branches:
+      - stable
+      - minor-next
+      - major-next
+      - "legacy/*"
+    paths:
+      - "src/VersionInfo.php"
+
+jobs:
+  check:
+    name: Check release
+    uses: ./.github/workflows/draft-release-pr-check.yml
+
+  draft:
+    name: Create GitHub draft release
+    needs: [check]
+    if: needs.check.outputs.valid == 'true'
+
+    uses: ./.github/workflows/draft-release.yml
+
+  post-draft-url-comment:
+    name: Post draft release URL as comment
+    needs: [draft]
+
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Post draft release URL on PR
+        uses: thollander/actions-comment-pull-request@v3
+        with:
+          message: "[Draft release ${{ needs.draft.outputs.version }}](${{ needs.draft.outputs.draft-url }}) has been created for commit ${{ github.sha }}. Please review and publish it."
+
+  trigger-post-release-workflow:
+    name: Trigger post-release RestrictedActions workflow
+    # Not sure if needs is actually needed here
+    needs: [check]
+    if: needs.check.outputs.valid == 'true'
+
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Generate access token
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.RESTRICTED_ACTIONS_DISPATCH_ID }}
+          private-key: ${{ secrets.RESTRICTED_ACTIONS_DISPATCH_KEY }}
+          owner: ${{ github.repository_owner }}
+          repositories: RestrictedActions
+
+      - name: Dispatch post-release restricted action
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          repository: ${{ github.repository_owner }}/RestrictedActions
+          event-type: pocketmine_mp_post_release
+          client-payload: '{"branch": "${{ github.ref }}"}'

.github/workflows/draft-release-from-tag.yml

@@ -0,0 +1,13 @@
+#Allows creating a release by pushing a tag
+#This might be useful for retroactive releases
+name: Draft release from git tag
+
+on:
+  push:
+    tags: "*"
+
+jobs:
+  draft:
+    name: Create GitHub draft release
+    if: "startsWith(github.event.head_commit.message, 'Release ')"
+    uses: ./.github/workflows/draft-release.yml