Publish releases with version notes for every tag (#762)

Author: LeoColomb

.editorconfig

@@ -9,3 +9,6 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+
+[*.js]
+indent_size = 2

.github/scripts/notes.js

@@ -0,0 +1,26 @@
+module.exports = async ({ core, fetch }) => {
+  const { VERSION } = process.env
+  const slug = `version-${VERSION.replaceAll('.', '-')}`
+
+  try {
+    const res = await fetch('https://wordpress.org/documentation/wp-json/wp/v2/wordpress-versions?per_page=50')
+    const data = await res.json()
+
+    const release = data.find((tag) => tag.slug === slug)
+    if (!release) {
+      throw Error('Release not found')
+    }
+
+    const { link } = release
+    const body = release.content?.rendered?.split('<h2', 4)[2]
+    if (!body) {
+      throw Error('Release body is empty or unexpected')
+    }
+
+    return `_Sourced from [WordPress.org Documentation](${link})._\n\n<h2${body}`
+  } catch (e) {
+    core.warning(e)
+
+    return `_Version notes available on [WordPress.org Documentation](https://wordpress.org/documentation/wordpress-version/${slug}/)._`
+  }
+}

.github/scripts/tags.js

@@ -0,0 +1,35 @@
+module.exports = async ({ github, context }) => {
+  const { PACKAGE, META } = process.env
+
+  const [{ data: currrentTags }, { data: upstreamTags }] = await Promise.all([
+    github.rest.repos.listTags({
+      owner: context.repo.owner,
+      repo: META.substring(META.indexOf('/') + 1),
+      per_page: 100,
+    }),
+    github.rest.repos.listTags({
+      owner: context.repo.owner,
+      repo: PACKAGE.substring(PACKAGE.indexOf('/') + 1),
+      per_page: 100,
+    }),
+  ])
+
+  const targetTags = await Promise.allSettled(
+    upstreamTags
+      .filter((tag) => !currrentTags.find((t) => t.name === tag.name))
+      .map((tag) =>
+        github.rest.git
+          .getRef({
+            owner: context.repo.owner,
+            repo: META.substring(META.indexOf('/') + 1),
+            ref: 'tags/' + tag.name,
+          })
+          .then(() => {})
+          .catch((res) => ({ tag: tag.name, status: res.status }))
+      )
+  )
+
+  return targetTags
+    .filter(({ value }) => value?.status === 404)
+    .map(({ value }) => value.tag)
+}

.github/workflows/meta-package.yml

@@ -10,7 +10,6 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       tags-matrix: ${{ steps.tags-matrix.outputs.result }}
-      latest-release: ${{ steps.latest-release.outputs.result }}
     steps:
       - uses: actions/checkout@v3
         with:
@@ -28,43 +27,8 @@ jobs:
           META: ${{ secrets.META_PACKAGE }}
         with:
           script: |
-            const { PACKAGE, META } = process.env
-            const [{ data: currrentTags }, { data: upstreamTags }] = await Promise.all([
-              github.rest.repos.listTags({
-                owner: context.repo.owner,
-                repo: META.substring(META.indexOf('/') + 1),
-                per_page: 100,
-              }),
-              github.rest.repos.listTags({
-                owner: context.repo.owner,
-                repo: PACKAGE.substring(PACKAGE.indexOf('/') + 1),
-                per_page: 100,
-              }),
-            ])
-            const targetTags = await Promise.allSettled(
-              upstreamTags
-                .filter((tag) => !currrentTags.find((t) => t.name === tag.name))
-                .map((tag) =>
-                  github.rest.git
-                    .getRef({
-                      owner: context.repo.owner,
-                      repo: META.substring(META.indexOf('/') + 1),
-                      ref: 'tags/' + tag.name,
-                    })
-                    .then(() => {})
-                    .catch((res) => ({ tag: tag.name, status: res.status }))
-                )
-            )
-            return targetTags
-              .filter(({ value }) => value?.status === 404)
-              .map(({ value }) => value.tag)
-
-      # Can't be used as is: some version release batches don't override latest version
-      # - name: Extract latest release
-      #   id: latest-release
-      #   env:
-      #     TAGS: ${{ steps.tags-matrix.outputs.result }}
-      #   run: echo "::set-output name=result::$(jq -r '.[0]' <<< "$TAGS")"
+            const tags = require('${{ github.workspace }}/.github/scripts/tags.js')
+            return await tags({ github, context })
 
   tags:
     name: Tags
@@ -89,7 +53,18 @@ jobs:
           repository: ${{ secrets.META_PACKAGE }}
           token: ${{ steps.generate-token.outputs.token }}
 
-      - name: Create a tag
+      - name: Retrieve version notes
+        id: notes
+        uses: actions/github-script@v6
+        env:
+          VERSION: ${{ matrix.tag }}
+        with:
+          result-encoding: string
+          script: |
+            const notes = require('${{ github.workspace }}/.github/scripts/notes.js')
+            return await notes({ core, fetch })
+
+      - name: Push tag
         env:
           TAG: ${{ matrix.tag }}
         run: |
@@ -98,25 +73,11 @@ jobs:
           git tag -a "${TAG}" -m "${TAG}"
           git push origin "${TAG}"
 
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    needs:
-      - sync
-      - tags
-    if: needs.sync.outputs.tags-matrix != '[]'
-    steps:
-      - name: Generate token
-        uses: tibdex/github-app-token@v1
-        id: generate-token
-        with:
-          app_id: ${{ secrets.BOT_APP_ID }}
-          private_key: ${{ secrets.BOT_PRIVATE_KEY }}
-
-      - name: Create a release
+      - name: Publish release
         uses: softprops/action-gh-release@v1
         with:
           repository: ${{ secrets.META_PACKAGE }}
           token: ${{ steps.generate-token.outputs.token }}
-          body: WordPress ${{ needs.sync.outputs.latest-release }}
-          tag_name: ${{ needs.sync.outputs.latest-release }}
+          body: ${{ steps.notes.outputs.result }}
+          name: Version ${{ matrix.tag }}
+          tag_name: ${{ matrix.tag }}