ci: comment when publish to npm/pypi finishes successfully (#6628)

This change adds a reusable `post-release-summary` composite action that automatically figures out the current/previous version, generates diff + PyPI/npm links, and posts (or updates) the release summary comment whenever the publish jobs succeed. ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6628-ci-comment-when-publish-to-npm-pypi-finishes-successfully-2a46d73d36508181a8d0eb050efe7762) by [Unito](https://www.unito.io)
2026-01-26 10:59:53 +00:00 · 2025-11-07 19:55:51 -08:00
parent 1f3fb90b1b
commit cafd2de961
3 changed files with 185 additions and 10 deletions
--- a/.github/actions/comment-release-links/action.yaml
+++ b/.github/actions/comment-release-links/action.yaml
@@ -0,0 +1,116 @@
+name: Post Release Summary Comment
+description: Post or update a PR comment summarizing release links with diff, derived versions, and optional extras.
+author: ComfyUI Frontend Team
+
+inputs:
+  issue-number:
+    description: Optional PR number override (defaults to the current pull request)
+    default: ''
+  version_file:
+    description: Path to the JSON file containing the current version (relative to repo root)
+    required: true
+
+outputs:
+  prev_version:
+    description: Previous version derived from the parent commit
+    value: ${{ steps.build.outputs.prev_version }}
+
+runs:
+  using: composite
+  steps:
+    - name: Build comment body
+      id: build
+      shell: bash
+      run: |
+        set -euo pipefail
+
+        VERSION_FILE="${{ inputs.version_file }}"
+        REPO="${{ github.repository }}"
+
+        if [[ -z "$VERSION_FILE" ]]; then
+          echo '::error::version_file input is required' >&2
+          exit 1
+        fi
+
+        PREV_JSON=$(git show HEAD^1:"$VERSION_FILE" 2>/dev/null || true)
+        if [[ -z "$PREV_JSON" ]]; then
+          echo "::error::Unable to read $VERSION_FILE from parent commit" >&2
+          exit 1
+        fi
+        PREV_VERSION=$(printf '%s' "$PREV_JSON" | node -pe "const data = JSON.parse(require('fs').readFileSync(0, 'utf8')); if (!data.version) { process.exit(1); } data.version")
+        if [[ -z "$PREV_VERSION" ]]; then
+          echo "::error::Unable to determine previous version from $VERSION_FILE" >&2
+          exit 1
+        fi
+
+        NEW_VERSION=$(node -pe "const fs=require('fs');const data=JSON.parse(fs.readFileSync(process.argv[1],'utf8'));if(!data.version){process.exit(1);}data.version" "$VERSION_FILE")
+        if [[ -z "$NEW_VERSION" ]]; then
+          echo "::error::Unable to determine current version from $VERSION_FILE" >&2
+          exit 1
+        fi
+
+        MARKER='release-summary'
+        MESSAGE='Publish jobs finished successfully:'
+        LINKS_VALUE=''
+
+        case "$VERSION_FILE" in
+          package.json)
+            LINKS_VALUE=$'PyPI|https://pypi.org/project/comfyui-frontend-package/{{version}}/\n''npm types|https://npm.im/@comfyorg/comfyui-frontend-types@{{version}}'
+            ;;
+          apps/desktop-ui/package.json)
+            MARKER='desktop-release-summary'
+            LINKS_VALUE='npm desktop UI|https://npm.im/@comfyorg/desktop-ui@{{version}}'
+            ;;
+        esac
+
+        DIFF_PREFIX='v'
+        DIFF_LABEL='Diff'
+        DIFF_URL="https://github.com/${REPO}/compare/${DIFF_PREFIX}${PREV_VERSION}...${DIFF_PREFIX}${NEW_VERSION}"
+        COMMENT_FILE=$(mktemp)
+
+        {
+          printf '<!--%s:%s%s-->\n' "$MARKER" "$DIFF_PREFIX" "$NEW_VERSION"
+          printf '%s\n\n' "$MESSAGE"
+          printf '- %s: [%s%s...%s%s](%s)\n' "$DIFF_LABEL" "$DIFF_PREFIX" "$PREV_VERSION" "$DIFF_PREFIX" "$NEW_VERSION" "$DIFF_URL"
+
+          while IFS= read -r RAW_LINE; do
+            LINE=$(printf '%s' "$RAW_LINE" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
+            [[ -z "$LINE" ]] && continue
+            if [[ "$LINE" != *"|"* ]]; then
+              echo "::warning::Skipping malformed link entry: $LINE" >&2
+              continue
+            fi
+            LABEL=${LINE%%|*}
+            URL_TEMPLATE=${LINE#*|}
+            URL=${URL_TEMPLATE//\{\{version\}\}/$NEW_VERSION}
+            URL=${URL_TEMPLATE//\{\{prev_version\}\}/$PREV_VERSION}
+            printf '- %s: %s\n' "$LABEL" "$URL"
+          done <<< "$LINKS_VALUE"
+
+          printf '\n'
+        } > "$COMMENT_FILE"
+
+        {
+          echo "body<<'EOF'"
+          cat "$COMMENT_FILE"
+          echo 'EOF'
+        } >> "$GITHUB_OUTPUT"
+        echo "prev_version=$PREV_VERSION" >> "$GITHUB_OUTPUT"
+        echo "marker_search=<!--$MARKER:" >> "$GITHUB_OUTPUT"
+        echo "new_version=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+
+    - name: Find existing comment
+      id: find
+      uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad
+      with:
+        issue-number: ${{ inputs.issue-number || github.event.pull_request.number }}
+        comment-author: github-actions[bot]
+        body-includes: ${{ steps.build.outputs.marker_search }}
+
+    - name: Post or update comment
+      uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9
+      with:
+        issue-number: ${{ inputs.issue-number || github.event.pull_request.number }}
+        comment-id: ${{ steps.find.outputs.comment-id }}
+        body: ${{ steps.build.outputs.body }}
+        edit-mode: replace
--- a/.github/workflows/publish-desktop-ui-on-merge.yaml
+++ b/.github/workflows/publish-desktop-ui-on-merge.yaml
@@ -1,9 +1,10 @@
+---
 name: Publish Desktop UI on PR Merge

 on:
  pull_request:
-    types: [ closed ]
-    branches: [ main, core/* ]
+    types: ['closed']
+    branches: [main, core/*]
    paths:
      - 'apps/desktop-ui/package.json'

@@ -57,3 +58,26 @@ jobs:
    secrets:
      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

+  comment_desktop_publish:
+    name: Comment Desktop Publish Summary
+    needs:
+      - resolve
+      - publish
+    if: success()
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Checkout merge commit
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+          fetch-depth: 2
+
+      - name: Post desktop release summary comment
+        uses: ./.github/actions/comment-release-links
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          version_file: apps/desktop-ui/package.json
--- a/.github/workflows/release-draft-create.yaml
+++ b/.github/workflows/release-draft-create.yaml
@@ -1,9 +1,10 @@
+---
 name: Release Draft Create

 on:
  pull_request:
-    types: [ closed ]
-    branches: [ main, core/* ]
+    types: ['closed']
+    branches: [main, core/*]
    paths:
      - 'package.json'

@@ -30,7 +31,9 @@ jobs:

      - name: Get current version
        id: current_version
-        run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
      - name: Check if prerelease
        id: check_prerelease
        run: |
@@ -71,7 +74,8 @@ jobs:
          name: dist-files
      - name: Create release
        id: create_release
-        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631
+        uses: >-
+          softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
@@ -79,9 +83,14 @@ jobs:
            dist.zip
          tag_name: v${{ needs.build.outputs.version }}
          target_commitish: ${{ github.event.pull_request.base.ref }}
-          make_latest: ${{ github.event.pull_request.base.ref == 'main' && needs.build.outputs.is_prerelease == 'false' }}
-          draft: ${{ github.event.pull_request.base.ref != 'main' || needs.build.outputs.is_prerelease == 'true' }}
-          prerelease: ${{ needs.build.outputs.is_prerelease == 'true' }}
+          make_latest: >-
+            ${{ github.event.pull_request.base.ref == 'main' &&
+                needs.build.outputs.is_prerelease == 'false' }}
+          draft: >-
+            ${{ github.event.pull_request.base.ref != 'main' ||
+                needs.build.outputs.is_prerelease == 'true' }}
+          prerelease: >-
+            ${{ needs.build.outputs.is_prerelease == 'true' }}
          generate_release_notes: true

  publish_pypi:
@@ -110,7 +119,8 @@ jobs:
        env:
          COMFYUI_FRONTEND_VERSION: ${{ needs.build.outputs.version }}
      - name: Publish pypi package
-        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc
+        uses: >-
+          pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc
        with:
          password: ${{ secrets.PYPI_TOKEN }}
          packages-dir: comfyui_frontend_package/dist
@@ -122,3 +132,28 @@ jobs:
      version: ${{ needs.build.outputs.version }}
      ref: ${{ github.event.pull_request.merge_commit_sha }}
    secrets: inherit
+
+  comment_release_summary:
+    name: Comment Release Summary
+    needs:
+      - draft_release
+      - publish_pypi
+      - publish_types
+    if: success()
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Checkout merge commit
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+          fetch-depth: 2
+
+      - name: Post release summary comment
+        uses: ./.github/actions/comment-release-links
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          version_file: package.json