Skip to content

fix(release): sync client manifest versions - #172

Open
nightcityblade wants to merge 4 commits into
microsoft:stagingfrom
nightcityblade:fix/issue-170
Open

fix(release): sync client manifest versions#172
nightcityblade wants to merge 4 commits into
microsoft:stagingfrom
nightcityblade:fix/issue-170

Conversation

@nightcityblade

Copy link
Copy Markdown

Description

Extends the release helper and promotion policy to update and validate the Claude and Codex client manifest versions alongside the five existing release fields. This prevents client plugin updates from remaining pinned to stale manifest versions.

The release helper also normalizes a single pending commit to an array so its dry-run path works when staging is exactly one commit ahead of main.

Related Issue

Fixes #170

Type of Change

  • 🐛 Bug fix
  • 📝 Documentation
  • 🔧 Config / build / CI

Affected area

  • Agent (plugins/winui/agents/, plugins/winui/agent-plugin/com.github.copilot/agents/) — N/A
  • Skill: N/A
  • Tool: N/A
  • Plugin metadata (plugin.json, plugins/winui/)
  • Repo-level docs / governance

Checklist

  • Tested locally on Windows (build + agent invocation if applicable) — N/A; release tooling was validated with PowerShell under RemoteSigned on macOS
  • If a skill changed: SKILL.md frontmatter still valid; cross-references to other skills still resolve — N/A
  • If Microsoft.WindowsAppSDK.Analyzers source changed: rebuilt the DLL and committed it (plugins/winui/agent-plugin/skills/winui-dev-workflow/analyzer/Microsoft.WindowsAppSDK.Analyzers.dll) — N/A
  • If a .ps1 script changed: tested under default RemoteSigned execution policy
  • If a CLI command or agent invocation changed: README.md updated — N/A
  • New tests added for new functionality (the release-policy gate now validates both client manifests)
  • If user-facing: added a bullet to ## [Unreleased] in CHANGELOG.md — N/A; no shipped plugin behavior changes
  • Did not edit any version field in plugins/winui/agent-plugin/plugin.json, .github/plugin/marketplace.json, or .claude-plugin/marketplace.json (versions bump only on the staging → main promotion PR — see RELEASING.md)

Screenshots / Demo

N/A; release automation only.

Additional Notes

Validation:

  • actionlint -ignore SC2001 .github/workflows/release-policy.yml
  • Isolated execution of the actual seven Set-JsonField calls: all seven fields updated to the same test version
  • Local simulation of the staging version-sync arrays: all seven fields detected and unchanged
  • pwsh -NoProfile -ExecutionPolicy RemoteSigned -File scripts/open-release-pr.ps1 -Version 0.6.1 -DryRun
  • git diff --check

SC2001 is an existing style warning in the unchanged changelog-validation step, so it was excluded from the actionlint run.

AI Description

This section is auto-generated by AI when the PR is opened or updated. To opt out, delete this entire section including the marker comments.

@microsoft-github-policy-service

Copy link
Copy Markdown

nightcityblade please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@nmetulev Nikola Metulev (nmetulev) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR correctly expands release version synchronization from five fields to seven, covering the Claude and Codex client manifests. I found two issues that need to be addressed before merging:

1. The release script changes files but does not commit them

What's wrong: scripts/open-release-pr.ps1 updates these manifests:

  • plugins/winui/.claude-plugin/plugin.json
  • plugins/winui/.codex-plugin/plugin.json

However, neither path is included in the later git add command. The generated release commit therefore keeps their old versions, and the new seven-field CI check rejects the release PR.

How to resolve it: Add both client-manifest paths to the git add block before the release commit is created.

2. CI checks seven versions on the PR but only five on main

What's wrong: .github/workflows/release-policy.yml validates all seven fields on the PR side, but its main-side consistency guard still reads and compares only the original five. For example, an incorrect Codex client version on main would not be detected by that guard.

How to resolve it: Read the Claude and Codex client versions from BASE_SHA, include them in MAIN_ALL and the main-side diagnostic output, and update the remaining “5 fields” message to “7 fields”.

Everything else in the PR looks consistent, including the release documentation and the single-commit PowerShell array fix.

@nightcityblade

Copy link
Copy Markdown
Author

Addressed both review findings: the release script now stages the Claude and Codex client manifests, and the main-side policy reads, compares, and reports all seven version fields. Validation: PowerShell parser passed and git diff --check passed.

@nmetulev

Copy link
Copy Markdown
Member

Thanks nightcityblade.

  • Could you make the main-side version mismatch fail CI instead of only printing an error and continuing?
  • And could you agree to the contributor license agreement (see comment above) so we can merge this pr?

@nightcityblade

Copy link
Copy Markdown
Author

Updated in 786c1e1: the main-side version consistency guard now exits with status 1 immediately when any of the seven fields differs. Validation: YAML parse and git diff --check both pass. The CELA acceptance requires an account-holder legal attestation, so I have not automated that step.

@grabinat

Tim (grabinat) commented Sep 8, 2026

Copy link
Copy Markdown

The CELA acceptance requires an account-holder legal attestation, so I have not automated that step.

I think there was some misunderstanding. You do not need to adjust your fix for the CLA. You just need to respond in this thread here with the an agree comment, to accept CLA for your contribution. See following comment how to do it:
#172 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants