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

Lint for and fix incorrect next-version tokens #38869

Merged
merged 1 commit into from
Aug 14, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Aug 13, 2024

Proposed changes:

The correct token is $$next-version$$. In the past, however, people have used incorrect tokens such as $next-version$ or $$next_version$$. Lint for these, and fix the existing instances.

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

Fixes #38760

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

No

Testing instructions:

  • CI happy?
  • Revert some of the fixes here and run the script. Does it catch them?
  • If you feel like it, double-check the version numbers in all the fixes.

The correct token is `$$next-version$$`. In the past, however, people
have used incorrect tokens such as `$next-version$` or
`$$next_version$$`. Lint for these, and fix the existing instances.

Fixes #38760
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Aug 13, 2024
@anomiex anomiex requested review from jeherve and a team August 13, 2024 19:47
@anomiex anomiex self-assigned this Aug 13, 2024
@anomiex anomiex enabled auto-merge (squash) August 13, 2024 19:47
Copy link
Contributor

github-actions bot commented Aug 13, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/incorrect-next-version-tokens branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/incorrect-next-version-tokens
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/incorrect-next-version-tokens
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Block] Subscriber Login [Package] Boost Core [Package] Plugins Installer [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] Sync [Package] WAF [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Actions GitHub actions used to automate some of the work around releases and repository management labels Aug 13, 2024
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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for September 3, 2024 (scheduled code freeze on September 2, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

Thanks for spending the time to fix existing incorrect references!

@anomiex anomiex merged commit 45da3f7 into trunk Aug 14, 2024
74 of 75 checks passed
@anomiex anomiex deleted the fix/incorrect-next-version-tokens branch August 14, 2024 08:01
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Aug 14, 2024
@github-actions github-actions bot added this to the jetpack/13.8 milestone Aug 14, 2024
pkuliga pushed a commit that referenced this pull request Aug 23, 2024
The correct token is `$$next-version$$`. In the past, however, people
have used incorrect tokens such as `$next-version$` or
`$$next_version$$`. Lint for these, and fix the existing instances.

Fixes #38760
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Actions GitHub actions used to automate some of the work around releases and repository management [Block] Subscriber Login [Package] Boost Core [Package] Plugins Installer [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] Sync [Package] WAF [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

$$next-version$$ token replacement: support underscore as well
2 participants