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.

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

tools: Improve speed of tools/changelogger-release.sh #39146

Merged

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Aug 29, 2024

Proposed changes:

The script has gotten a bit slow, since it was running check-intra-monorepo-deps.sh individually for each project to pass either -u or -U depending on whether the project was included in the release or not.

We can speed it up by running check-intra-monorepo-deps.sh -U just once, and then looking at the git diff to see whether any changelog entries seem to be needed.

Also, we can then drop the PACKAGE_VERSIONS_CACHE thing from check-intra-monorepo-deps.sh that was done in a prior speedup attempt.

And finally, skip trying to handle the "monorepo" pseudo-package, it won't work and prevents releases of projects depended on by the monorepo root.

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

None

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

No

Testing instructions:

The script has gotten a bit slow, since it was running
`check-intra-monorepo-deps.sh` individually for each project to pass
either `-u` or `-U` depending on whether the project was included in the
release or not.

We can speed it up by running `check-intra-monorepo-deps.sh -U` just
once, and then looking at the git diff to see whether any changelog
entries seem to be needed.

Also, we can then drop the `PACKAGE_VERSIONS_CACHE` thing from
`check-intra-monorepo-deps.sh` that was done in a prior speedup attempt.

And finally, skip trying to handle the "monorepo" pseudo-package, it
won't work and prevents releases of projects depended on by the monorepo
root.
@anomiex anomiex added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Pri] Normal labels Aug 29, 2024
@anomiex anomiex requested a review from a team August 29, 2024 19:04
@anomiex anomiex self-assigned this Aug 29, 2024
@anomiex anomiex enabled auto-merge (squash) August 29, 2024 19:04
Copy link
Contributor

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 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 merged commit 7c988d4 into trunk Sep 2, 2024
56 checks passed
@anomiex anomiex deleted the update/tools-improve-changelogger-release-script-speed branch September 2, 2024 15:57
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 2, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
The script has gotten a bit slow, since it was running
`check-intra-monorepo-deps.sh` individually for each project to pass
either `-u` or `-U` depending on whether the project was included in the
release or not.

We can speed it up by running `check-intra-monorepo-deps.sh -U` just
once, and then looking at the git diff to see whether any changelog
entries seem to be needed.

Also, we can then drop the `PACKAGE_VERSIONS_CACHE` thing from
`check-intra-monorepo-deps.sh` that was done in a prior speedup attempt.

And finally, skip trying to handle the "monorepo" pseudo-package, it
won't work and prevents releases of projects depended on by the monorepo
root.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Pri] Normal [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants