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

test: add the wordpress plugin check action #92

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

MaferMazu
Copy link
Contributor

@MaferMazu MaferMazu commented Sep 3, 2024

Description

This PR adds a GitHub workflow to run WordPress/plugin-check-action.

This PR also refactors the workflows.
The zip version generated with this PR is: openedx-commerce.zip

Testing instructions

The test WordPress Plugin Check / Plugin Check passed.

Additional information

This test mounts a WordPress environment, installs our plugin using a version similar to our ZIP release, activates the plugin in this new environment, installs the Plugin check (PCP) by WordPress Performance Team and Plugin Review Team, and run the test over our plugin.

Checks tested: i18n_usage, code_obfuscation, direct_db_queries, enqueued_scripts_in_footer, enqueued_scripts_size, enqueued_styles_scope, file_type, late_escaping, localhost, no_unfiltered_uploads, performant_wp_query_params, plugin_header_text_domain, plugin_readme, plugin_review_phpcs, plugin_updater, trademarks.

Categories tested: accessibility, general, performance, plugin_repo, security.

More info in: WordPress/plugin-check-action

Important

This will increase the test execution time by ~ 2 minutes.

Checklist for Merge

  • Tested in a remote environment
  • Updated documentation
  • Rebased master/main
  • Squashed commits

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 3, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 3, 2024

Thanks for the pull request, @MaferMazu!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @mafermazu. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@MaferMazu MaferMazu force-pushed the mfmz/add-plugin-checker branch 3 times, most recently from cb1f828 to f98acbc Compare September 3, 2024 20:44
@MaferMazu MaferMazu changed the title ci: add the wordpress plugin check action test: add the wordpress plugin check action Sep 3, 2024
@MaferMazu MaferMazu force-pushed the mfmz/add-plugin-checker branch from f98acbc to 7de2a84 Compare September 3, 2024 20:49
@MaferMazu MaferMazu marked this pull request as ready for review September 5, 2024 13:21
@felipemontoya
Copy link
Member

This looks fantastic.

Have you tried this failing? we can make a new PR against this branch that does one of the things that should break this plugin check.

@MaferMazu
Copy link
Contributor Author

Here is a PR with WordPress Plugin Check / Plugin Check failing: #94
Action failing: https://github.com/openedx/openedx-wordpress-ecommerce/actions/runs/10722515445/job/29733613522?pr=94
Change that makes it fail: 3e09dc1

@felipemontoya
Copy link
Member

Great! Thanks for that test PR.

@MaferMazu MaferMazu force-pushed the mfmz/add-plugin-checker branch from e2a6317 to 89ef617 Compare September 5, 2024 15:58
@MaferMazu MaferMazu force-pushed the mfmz/add-plugin-checker branch from 89ef617 to 649ad0b Compare September 5, 2024 16:22
@MaferMazu
Copy link
Contributor Author

@felipemontoya, thanks for the feedback. I refactored the workflows, and the zip version generated is openedx-commerce.zip

Note: I added the cd command in the zip process to zip the content but not the folder.

This is ready for a re-review.

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

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

This looks perfect. Thanks a lot

@MaferMazu MaferMazu merged commit 6bda83b into openedx:main Sep 5, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants