Skip to content

feat: add changelog ref inputs to post-release-verify action - #64

Closed
Svitlana-Dykun wants to merge 5 commits into
mainfrom
cursor/post-release-verify-changelog-ref-2770
Closed

Svitlana-Dykun wants to merge 5 commits into
mainfrom
cursor/post-release-verify-changelog-ref-2770

Conversation

@Svitlana-Dykun

@Svitlana-Dykun Svitlana-Dykun commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Problem

The post-release-verify action's "Changelog on main (Pro/Core)" check currently reads changelog entries from the main branch. For Elementor Pro, the changelog only reaches main after a manual cp_main cherry-pick, which typically lands after the release is published. This causes the verify job to fail and downstream jobs (like "Upgrade site smoke") to be skipped.

Example: Pro 4.3.2 (PR #7792) failed verification because the changelog was not yet on main at release time.

Solution

Added optional inputs to both the post-release-verify action and the reusable post-release-check.yml workflow:

  • core-changelog-ref / core_changelog_ref: Git ref to check for Core changelog (defaults to main)
  • pro-changelog-ref / pro_changelog_ref: Git ref to check for Pro changelog (defaults to main)

Both inputs default to main to maintain backward compatibility - existing callers continue working exactly as before.

Usage for elementor-pro

In elementor-pro's .github/workflows/post-release-check.yml, add the pro_changelog_ref input when calling this reusable workflow:

jobs:
  post-release-check:
    if: github.repository_owner == 'elementor'
    uses: elementor/elementor-editor-github-actions/.github/workflows/post-release-check.yml@main
    with:
      core_version: ${{ inputs.core_version }}
      pro_version: ${{ inputs.pro_version }}
      pro_changelog_ref: ${{ inputs.pro_version }}  # ← Add this line (use the release tag)
      skip_wordpress_org: ${{ inputs.skip_wordpress_org }}
      skip_smoke: ${{ inputs.skip_smoke }}
      actions_ref: main
    secrets:
      MAINTAIN_TOKEN: ${{ secrets.MAINTAIN_TOKEN }}

This tells the action to check the release tag (e.g., 4.3.2) for the changelog instead of main, avoiding the cp_main timing issue.

Note: Use inputs.pro_version (the release tag like 4.3.2), not a custom variable. If elementor-pro's workflow dispatch uses a different input name like version, adjust accordingly.

Changes

Action (actions/post-release-verify/action.yml)

  1. Added core-changelog-ref and pro-changelog-ref inputs with main defaults
  2. Updated TypeScript types to include the new ref parameters
  3. Updated the checkMainChangelog function to accept and use a ref parameter
  4. Updated check titles to reflect the actual ref being checked (e.g., "Changelog on 4.3.2 (Pro)")
  5. Updated README documentation

Reusable Workflow (.github/workflows/post-release-check.yml)

  1. Added core_changelog_ref and pro_changelog_ref inputs to both workflow_dispatch and workflow_call
  2. Pass both inputs through to the post-release-verify action
  3. Both default to main for backward compatibility

Build Artifacts

  • Rebuilt actions/post-release-verify/dist/index.js with the changes

Verification

  • ✅ Build succeeds (npm run build)
  • ✅ All lints pass (npm run lint - eslint, tsc, prettier)
  • ✅ Backward compatibility maintained (all inputs default to main)
  • ✅ No breaking changes to existing callers
Open in Web Open in Cursor 

cursoragent and others added 4 commits October 22, 2026 08:30
Add optional core-changelog-ref and pro-changelog-ref inputs to allow
callers to specify which git ref to check for changelog entries.
This resolves the issue where Pro's changelog only reaches main after
a manual cp_main cherry-pick, which can happen after the release.

Defaults to 'main' to maintain backward compatibility.

Ref: https://github.com/elementor/elementor-pro/pull/7792#discussion_r4345754281

Co-authored-by: Svitlana-Dykun <Svitlana-Dykun@users.noreply.github.com>
Add core_changelog_ref and pro_changelog_ref inputs to the reusable
post-release-check.yml workflow and pass them through to the
post-release-verify action. This allows elementor-pro to specify
which git ref to check for the changelog when calling the workflow.

Both inputs default to 'main' for backward compatibility.

Co-authored-by: Svitlana-Dykun <Svitlana-Dykun@users.noreply.github.com>
Empty changelog refs use the version being verified, so a stable release
passes before the changelog sync to main.

Co-authored-by: Cursor <cursoragent@cursor.com>
The post-release workflow already passes the version tag.

Co-authored-by: Cursor <cursoragent@cursor.com>
@Svitlana-Dykun
Svitlana-Dykun marked this pull request as ready for review October 22, 2026 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants