Skip to content
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

Use present tense in automated changelog entries #41646

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open

Use present tense in automated changelog entries #41646

wants to merge 3 commits into from

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Feb 7, 2025

This is a simple PR to make sure our automated changelog entries are put in present tense.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Should be pretty straight-forward...

@tbradsha tbradsha added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial labels Feb 7, 2025
@tbradsha tbradsha requested a review from a team February 7, 2025 21:13
@tbradsha tbradsha self-assigned this Feb 7, 2025
@github-actions github-actions bot added [Tools] Development CLI The tools/cli to assist during JP development. Actions GitHub actions used to automate some of the work around releases and repository management labels Feb 7, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 7, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

anomiex
anomiex previously approved these changes Feb 7, 2025
View reviewed changes
tools/changelogger-release.sh
else
debug " $DS has lockfile changes only"
changelogger_add '' 'Updated composer.lock.'
changelogger_add '' 'Update composer.lock.'
Copy link
Contributor

Choose a reason for hiding this comment

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

Since you did this one, you should probably do

jetpack/tools/check-intra-monorepo-deps.sh

Line 252 in 080b341

do_changelogger "$SLUG" '' 'Updated composer.lock.'

as well

Copy link
Contributor Author

Choose a reason for hiding this comment

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

1e70618

tools/cli/commands/changelog.js
@@ -369,8 +369,8 @@ async function addIndirectPlugins( argv, directProjects, changelogFiles ) {
for ( const file of changelogFiles.get( proj ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we update the comment just above?

jetpack/tools/cli/commands/changelog.js

Line 366 in 080b341

// If it has a changelog file other than "Updated composer.lock" or "Updated dependencies", skip it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

beb63c0

@tbradsha tbradsha requested a review from anomiex February 7, 2025 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anomiex anomiex Awaiting requested review from anomiex

Assignees

@tbradsha tbradsha

Labels
Actions GitHub actions used to automate some of the work around releases and repository management [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Tools] Development CLI The tools/cli to assist during JP development. [Type] Janitorial
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tbradsha @anomiex