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

Scan JS Package: Remove Build #40318

Closed
wants to merge 1 commit into from
Closed

Conversation

nateweller
Copy link
Contributor

@nateweller nateweller commented Nov 22, 2024

To ensure compatibility with __() and @wordpress/i18n, the scan package needs to be built by consumers such as the Jetpack and Jetpack Protect plugins.

Proposed changes:

  • Removes references to a "build" directory from the package.json file, opting to provide the TS source code directly to consumers.
  • Removes use of jetpack:src from exports, since default is now the same ./src/index.ts value.

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

p1732032090059999-slack-CDLH4C1UZ

peb6dq-36i-p2

#40262

#40299

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

No

Testing instructions:

  • Ensure all builds and tests are passing.
  • Run cd projects/js-packages/storybook && npm run storybook:dev
  • Open http://localhost:50240/?path=/docs/js-packages-components-threat-fixer-button--docs
  • Validate that the component renders (uses methods from the Scan package).
Screenshot 2024-11-19 at 1 53 42 PM

@nateweller nateweller self-assigned this Nov 22, 2024
@nateweller nateweller added the [Type] Bug When a feature is broken and / or not performing as intended label Nov 22, 2024
Copy link
Contributor

github-actions bot commented Nov 22, 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/scan/remove-build 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/scan/remove-build
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/scan/remove-build
    

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

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!

@nateweller nateweller added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Status] Needs Team Review and removed [Status] In Progress labels Nov 23, 2024
@nateweller nateweller requested review from anomiex and a team November 23, 2024 00:37
@nateweller nateweller marked this pull request as ready for review November 23, 2024 00:45
@nateweller nateweller mentioned this pull request Nov 23, 2024
3 tasks
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

To ensure compatibility with __() and @wordpress/i18n, the scan package needs to be built by consumers such as the Jetpack and Jetpack Protect plugins.

As mentioned at peb6dq-3as-p2#comment-2024, this isn't really a good reason to do this. But there are other reasons you might decide to make the package TS-only (at least for now), and this PR is good to do that.

@nateweller
Copy link
Contributor Author

Closing in favor of #40299

@nateweller nateweller closed this Nov 26, 2024
@github-actions github-actions bot removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Status] Needs Team Review labels Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Scan RNA [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants