Add update workflow (#3727)

* add handle-update workflow

* direct expansion

* typo

* update node

* fix

* fix

* fix

Author: extremeheat

.github/helper/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "gh-helpers": "^1.0.0"
+  }
+}

.github/helper/updator.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+/**
+ * Updator script triggered from minecraft-data repository to auto generate PR
+ */
+const fs = require('fs')
+const cp = require('child_process')
+const assert = require('assert')
+const github = require('gh-helpers')()
+const { join } = require('path')
+const exec = (cmd) => github.mock ? console.log('> ', cmd) : (console.log('> ', cmd), cp.execSync(cmd, { stdio: 'inherit' }))
+
+console.log('Starting update process...')
+// Sanitize and validate environment variables all non alpha numeric / underscore / dot
+const newVersion = process.env.NEW_MC_VERSION?.replace(/[^a-zA-Z0-9_.]/g, '_')
+const triggerBranch = process.env.MCDATA_BRANCH?.replace(/[^a-zA-Z0-9_.]/g, '_')
+const mcdataPrURL = process.env.MCDATA_PR_URL
+console.log({ newVersion, triggerBranch, mcdataPrURL })
+
+assert(newVersion)
+assert(triggerBranch)
+
+async function main () {
+  const currentSupportedPath = require.resolve('../../lib/version.js')
+  const readmePath = join(__dirname, '../../docs/README.md')
+  const ciPath = join(__dirname, '../../.github/workflows/ci.yml')
+
+  // Update the version.js
+  const currentSupportedVersion = require('../../lib/version.js')
+  const currentContents = fs.readFileSync(currentSupportedPath, 'utf8')
+  console.log('Current supported version:', currentContents)
+  const latestV = currentSupportedVersion.testedVersions.at(-1)
+  const newContents = currentContents.includes(newVersion)
+    ? currentContents
+    : currentContents
+      .replace(`, '${latestV}'`, `, '${latestV}', '${newVersion}'`)
+
+  // Update the README.md
+  const currentContentsReadme = fs.readFileSync(readmePath, 'utf8')
+  if (!currentContentsReadme.includes(newVersion)) {
+    const newReadmeContents = currentContentsReadme
+      .replace(/Minecraft 1\.8 to [0-9A-Za-z._-]+ \(/, `Minecraft 1.8 to ${newVersion} (`)
+      .replace(') <!--version-->', `, ${newVersion}) <!--version-->`)
+    fs.writeFileSync(readmePath, newReadmeContents)
+    console.log('Updated README with new version:', newVersion)
+  }
+  fs.writeFileSync(currentSupportedPath, newContents)
+
+  // Update the CI workflow
+  const currentContentsCI = fs.readFileSync(ciPath, 'utf8')
+  if (!currentContentsCI.includes(newVersion)) {
+    const newCIContents = currentContentsCI.replace(
+      'run: npm install', `run: npm install
+      - run: cd node_modules && cd minecraft-data && mv minecraft-data minecraft-data-old && git clone -b ${triggerBranch} https://github.com/PrismarineJS/minecraft-data --depth 1 && node bin/generate_data.js
+      - run: curl -o node_modules/protodef/src/serializer.js https://raw.githubusercontent.com/extremeheat/node-protodef/refs/heads/dlog/src/serializer.js && curl -o node_modules/protodef/src/compiler.js https://raw.githubusercontent.com/extremeheat/node-protodef/refs/heads/dlog/src/compiler.js
+`)
+    fs.writeFileSync(ciPath, newCIContents)
+    console.log('Updated CI workflow with new version:', newVersion)
+  }
+
+  const branchName = 'pc' + newVersion.replace(/[^a-zA-Z0-9_]/g, '_')
+  exec(`git checkout -b ${branchName}`)
+  exec('git config user.name "github-actions[bot]"')
+  exec('git config user.email "41898282+github-actions[bot]@users.noreply.github.com"')
+  exec('git add --all')
+  exec(`git commit -m "Update to version ${newVersion}"`)
+  exec(`git push origin ${branchName} --force`)
+  //     createPullRequest(title: string, body: string, fromBranch: string, intoBranch?: string): Promise<{ number: number, url: string }>;
+  const pr = await github.createPullRequest(
+    `🎈 ${newVersion}`,
+    `This automated PR sets up the relevant boilerplate for Minecraft version ${newVersion}.
+
+Ref: ${mcdataPrURL}
+
+* You can help contribute to this PR by opening a PR against this <code branch>${branchName}</code> branch instead of <code>master</code>.
+    `,
+    branchName,
+    'master'
+  )
+  console.log(`Pull request created`, pr)
+}
+
+main().catch(err => {
+  console.error('Error during update process:', err)
+  process.exit(1)
+})

.github/workflows/handle-update.yml

@@ -0,0 +1,54 @@
+name: Update from minecraft-data
+
+on:
+  workflow_dispatch:
+    inputs:
+      new_mc_version:
+        description: New minecraft version number
+        required: true
+        type: string
+      mcdata_branch:
+        description: minecraft-data branch for this version
+        required: true
+        type: string
+      mcdata_pr_url:
+        description: minecraft-data PR number to open a PR here against
+        required: false
+        default: ''
+        type: string
+      nmp_branch:
+        description: minecraft-protocol branch for this version
+        required: true
+        type: string
+      nmp_pr_url:
+        description: minecraft-protocol PR number to open a PR here against
+        required: false
+        default: ''
+        type: string
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.PAT_PASSWORD }}
+
+    - name: Use Node.js 22.x
+      uses: actions/setup-node@v1.4.4
+      with:
+        node-version: 22.x
+
+    - run: npm install PrismarineJS/node-minecraft-protocol#${{ github.event.inputs.nmp_branch }}
+
+    - name: Run updator script
+      run: cd .github/helper && npm install && node updator.js
+      env:
+        GITHUB_TOKEN: ${{ secrets.PAT_PASSWORD }}
+        NEW_MC_VERSION: ${{ github.event.inputs.new_mc_version }}
+        MCDATA_BRANCH: ${{ github.event.inputs.mcdata_branch }}
+        MCDATA_PR_URL: ${{ github.event.inputs.mcdata_pr_url }}
+        NMP_BRANCH: ${{ github.event.inputs.nmp_branch }}
+        NMP_PR_URL: ${{ github.event.inputs.nmp_pr_url }}

docs/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8 to 1.21 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, and 1.21)
+ * Supports Minecraft 1.8 to 1.21 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21) <!--version-->
  * Entity knowledge and tracking.
  * Block knowledge. You can query the world around you. Milliseconds to find any block.
  * Physics and movement - handle all bounding boxes