Skip to content

Prevent override of changelog version #60203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 5, 2025
Merged

Prevent override of changelog version #60203

merged 2 commits into from
Aug 5, 2025

Conversation

albarin
Copy link
Contributor

@albarin albarin commented Aug 5, 2025 •
edited
Loading

Submission Review Guidelines:

Changes proposed in this Pull Request:

This PR prevents overwriting the version number in readme.txt when running the Release: Compile changelog workflow.

Closes #59854

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

  1. Fork the woocommerce/woocommerce repo with all branches into your GH account.
  2. In the forked repo, create a PR with the branch 59854/keep-changelog-version and merge it (to get these changes into trunk).
  3. Run the Release: Bump version number workflow with release/10.0 and stable.
  4. Merge the resulting PR.
  5. Run the Release: Compile changelog with version 10.0 and fill the Release date in YYYY-MM-DD format input with a valid date.
  6. Ensure the workflow finishes successfully. Check the resulting PR and confirm the release version remains unchanged and the date changes to the one you used in step 5.

Testing that has already taken place:

Tested the steps on my fork https://github.com/albarin/woocommerce/pull/24/files

Changelog entry

  • Automatically create a changelog entry from the details below.
  • This Pull Request does not require a changelog entry. (Comment required below)
Changelog Entry Details

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Changelog Entry Comment

Comment

@github-actions github-actions bot added the focus: monorepo infrastructure Issues and PRs related to monorepo tooling. label Aug 5, 2025
@albarin albarin marked this pull request as ready for review August 5, 2025 09:12
@albarin albarin requested a review from a team as a code owner August 5, 2025 09:12
@albarin albarin requested review from jorgeatorres and removed request for a team August 5, 2025 09:12
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 5, 2025 •
edited
Loading

Testing Guidelines

Hi @jorgeatorres @woocommerce/flux,

Apart from reviewing the code changes, please make sure to review the testing instructions (Guide) and verify that relevant tests (E2E, Unit, Integration, etc.) have been added or updated as needed.

Reminder: PR reviewers are required to document testing performed. This includes:

  • 🖼️ Screenshots or screen recordings.
  • 📝 List of functionality tested / steps followed.
  • 🌐 Site details (environment attributes such as hosting type, plugins, theme, store size, store age, and relevant settings).
  • 🔍 Any analysis performed, such as assessing potential impacts on environment attributes and other plugins, conducting performance profiling, or using LLM/AI-based analysis.

⚠️ Within the testing details you provide, please ensure that no sensitive information (such as API keys, passwords, user data, etc.) is included in this public issue.

@woocommercebot woocommercebot requested a review from a team August 5, 2025 09:12
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The workflow file .github/workflows/release-compile-changelog.yml was updated to output the current_version variable from the selected branch and to use this value in the changelog generation step, ensuring the changelog uses the actual version from the branch rather than the input version.

Changes

Cohort / File(s) Change Summary
GitHub Actions Workflow Update
.github/workflows/release-compile-changelog.yml		 Modified to output current_version from the branch and use it in the changelog generation step instead of the input version.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant ValidateVersion
    participant ValidateBranchVersion
    participant GenerateChangelog

    Workflow->>ValidateVersion: Validate input version
    Workflow->>ValidateBranchVersion: Get current_version from branch
    ValidateBranchVersion-->>Workflow: Output current_version
    Workflow->>GenerateChangelog: Use current_version for changelog generation
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5-10 minutes

Possibly related PRs

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cdec083 and e74503b.

📒 Files selected for processing (1)
  • .github/workflows/release-compile-changelog.yml (2 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings 
Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59675
File: .github/workflows/release-bump-as-requirement.yml:48-65
Timestamp: 2025-07-15T15:39:21.856Z
Learning: In WooCommerce core repository, changelog entries for all PRs live in `plugins/woocommerce/changelog/` directory and are processed during releases, not at the repository root level.

Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Applies to .github/PULL_REQUEST_TEMPLATE.md : Preserve required markdown sections in the PR description, especially those used by automation (e.g., changelog entry details and comments). Do not remove or alter them.

Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Provide clear, step-by-step instructions for how to test the changes in the PR description.

Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Applies to .github/PULL_REQUEST_TEMPLATE.md : The changelog section in the PR description must keep the markdown structure from the PR template exactly as-is, including all checkboxes, comments, and headings. Only the appropriate checkbox may be checked, and the changelog message must be placed under the `#### Comment` heading and before the closing `</details>` tag. Do not add, remove, or reformat any part of the changelog section except for checking the box and adding the message in the correct place.

Learnt from: prettyboymp
PR: woocommerce/woocommerce#59048
File: .github/workflows/cherry-pick-milestoned-prs.yml:118-131
Timestamp: 2025-07-11T13:05:08.440Z
Learning: In GitHub Actions workflows, when reviewing steps that access event data like `github.event.pull_request.milestone`, check the entire job dependency chain and conditional logic. If upstream jobs already validate the data exists (like checking `github.event.pull_request.milestone != null` in a prerequisite job), then downstream jobs don't need redundant null-checks since the data is guaranteed to exist by that point.

Learnt from: lysyjan
PR: woocommerce/woocommerce#59632
File: packages/js/email-editor/src/layouts/flex-email.tsx:116-122
Timestamp: 2025-07-14T10:41:46.200Z
Learning: In WooCommerce projects, formatting suggestions should respect the project's Prettier configuration and linting rules. Changes that would break the lint job should be avoided, even if they appear to improve readability.

Learnt from: prettyboymp
PR: woocommerce/woocommerce#59048
File: .github/workflows/cherry-pick-milestoned-prs.yml:60-83
Timestamp: 2025-06-26T12:45:40.709Z
Learning: WooCommerce uses WordPress versioning conventions where minor versions in X.Y.Z format are constrained to 0-9 (Y cannot exceed 9). This means version increment logic should reset minor to 0 and increment major when minor reaches 9, rather than allowing two-digit minor versions like 9.10 or 9.11.

Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/git.mdc:0-0
Timestamp: 2025-07-18T14:54:55.592Z
Learning: Branch names should follow the structure: 'release/{version}' for release branches.
📚 Learning: in woocommerce core repository, changelog entries for all prs live in `plugins/woocommerce/changelog... 
Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59675
File: .github/workflows/release-bump-as-requirement.yml:48-65
Timestamp: 2025-07-15T15:39:21.856Z
Learning: In WooCommerce core repository, changelog entries for all PRs live in `plugins/woocommerce/changelog/` directory and are processed during releases, not at the repository root level.

Applied to files:

  • .github/workflows/release-compile-changelog.yml
📚 Learning: in github actions workflows, when reviewing steps that access event data like `github.event.pull_req... 
Learnt from: prettyboymp
PR: woocommerce/woocommerce#59048
File: .github/workflows/cherry-pick-milestoned-prs.yml:118-131
Timestamp: 2025-07-11T13:05:08.440Z
Learning: In GitHub Actions workflows, when reviewing steps that access event data like `github.event.pull_request.milestone`, check the entire job dependency chain and conditional logic. If upstream jobs already validate the data exists (like checking `github.event.pull_request.milestone != null` in a prerequisite job), then downstream jobs don't need redundant null-checks since the data is guaranteed to exist by that point.

Applied to files:

  • .github/workflows/release-compile-changelog.yml
📚 Learning: ensure that the correct version of node is installed and being used by running 'nvm install' in the ... 
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/woo-build.mdc:0-0
Timestamp: 2025-07-28T05:05:41.091Z
Learning: Ensure that the correct version of Node is installed and being used by running 'nvm install' in the main repository directory.

Applied to files:

  • .github/workflows/release-compile-changelog.yml
📚 Learning: applies to .github/pull_request_template.md : the changelog section in the pr description must keep ... 
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Applies to .github/PULL_REQUEST_TEMPLATE.md : The changelog section in the PR description must keep the markdown structure from the PR template exactly as-is, including all checkboxes, comments, and headings. Only the appropriate checkbox may be checked, and the changelog message must be placed under the `#### Comment` heading and before the closing `</details>` tag. Do not add, remove, or reformat any part of the changelog section except for checking the box and adding the message in the correct place.

Applied to files:

  • .github/workflows/release-compile-changelog.yml
🔇 Additional comments (2)
.github/workflows/release-compile-changelog.yml (2)

137-138: Outputting current_version is the right fix
Exposing the branch-derived current_version via $GITHUB_OUTPUT allows downstream steps to rely on the actual version checked into the branch, preventing accidental overrides. 👍

158-158: Changelog step now consumes the correct version
Switching VERSION to steps.validate-selected-branch-version.outputs.current_version removes the dependency on the dispatched input and guarantees consistency with the branch state.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 59854/keep-changelog-version

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

jorgeatorres
jorgeatorres approved these changes Aug 5, 2025
View reviewed changes
Copy link
Member

@jorgeatorres jorgeatorres left a comment

Choose a reason for hiding this comment

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

LGTM. Tested well. Thank you @albarin!

@albarin albarin merged commit a7ac75c into trunk Aug 5, 2025
16 checks passed
@albarin albarin deleted the 59854/keep-changelog-version branch August 5, 2025 15:24
@jorgeatorres jorgeatorres mentioned this pull request Aug 7, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorgeatorres jorgeatorres jorgeatorres approved these changes

Assignees
No one assigned
Labels
focus: monorepo infrastructure Issues and PRs related to monorepo tooling.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Changelog workflow overwrites version number in readme.txt
2 participants
@albarin @jorgeatorres