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

Social Logos: Add post-build tests #38224

Merged
merged 4 commits into from
Nov 5, 2024
Merged

Social Logos: Add post-build tests #38224

merged 4 commits into from
Nov 5, 2024

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Jul 5, 2024

This moves the existing test out of the build script and adds a few more rudimentary post-build tests. This will help prevent silent errors from resulting in a broken build (e.g. regressions discovered/fixed in #37799).

As written, it runs as part of composer build-production. Feel free to adapt as desired.

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:

Run composer build-production and verify it works as expected.

Copy link
Contributor

github-actions bot commented Jul 5, 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 add/social-logos/tests 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 add/social-logos/tests
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/social-logos/tests
    

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

github-actions bot commented Jul 5, 2024

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!

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.

I think #37799 probably already cleaned up most of the possibilities for errors by making the various scripts actually fail if something goes wrong.

projects/js-packages/social-logos/tests/tests.js Outdated Show resolved Hide resolved
projects/js-packages/social-logos/tests/tests.js Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Oct 8, 2024

This PR has been marked as stale. This happened because:

  • It has been inactive for the past 3 months.
  • It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

If this PR is still useful, please do a [trunk merge or rebase](https://github.com/Automattic/jetpack/blob/trunk/docs/git-workflow.md#keeping-your-branch-up-to-date) and otherwise make sure it's up to date and has clear testing instructions. You may also want to ping possible reviewers in case they've forgotten about it. Please close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

If the PR is not updated (or at least commented on) in another month, it will be automatically closed.

@tbradsha
Copy link
Contributor Author

tbradsha commented Oct 8, 2024

I don't really care about the specifics of most of the tests (other than exit code 2); mostly I wanted to decouple tests from the build process, and figured I'd add a few simple tests in the meantime. Happy to remove any deemed pointless!

@tbradsha tbradsha force-pushed the add/social-logos/tests branch from e677062 to dee7678 Compare October 8, 2024 19:31
@tbradsha
Copy link
Contributor Author

tbradsha commented Oct 8, 2024

Rebased.

@tbradsha tbradsha force-pushed the add/social-logos/tests branch from dee7678 to 80f9ca5 Compare November 1, 2024 11:38
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.

Let's do it

@tbradsha tbradsha merged commit 4b83bb9 into trunk Nov 5, 2024
73 of 74 checks passed
@tbradsha tbradsha deleted the add/social-logos/tests branch November 5, 2024 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants