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

Tests: Prevent filename conflict on @actions/upload-artifact #40042

Merged
merged 3 commits into from
Nov 5, 2024

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Nov 4, 2024

This changes the project name in the E2E matrix from Jetpack Boost - Concatenate JS/CSS to Jetpack Boost - Concatenate JS and CSS.

Why? If a E2E project has a name deemed invalid by @actions/upload-artifact, it'll fail to upload that artifact (and subsequent ones), e.g.:

https://github.com/Automattic/jetpack/actions/runs/11645549949

Error: The artifact name is not valid: test-output-Jetpack Boost - Concatenate JS/CSS. Contains the following character:  Forward slash /
          
Invalid characters include:  Double quote ", Colon :, Less than <, Greater than >, Vertical bar |, Asterisk *, Question mark ?, Carriage return \r, Line feed \n, Backslash \, Forward slash /

Solving this took me down a rabbit hole (e.g. looking in the actual test name rather than the matrix, checking for upload-artifact rename abilities, GH Actions string manipulation in expression syntax). This seems to be the best and simplest solution.

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:

Confirm artifacts are properly uploaded:
https://github.com/Automattic/jetpack/actions/runs/11672407033?pr=40042

@tbradsha tbradsha requested a review from a team November 4, 2024 20:44
@tbradsha tbradsha self-assigned this Nov 4, 2024
@github-actions github-actions bot added [Status] In Progress Actions GitHub actions used to automate some of the work around releases and repository management labels Nov 4, 2024
Copy link
Contributor

github-actions bot commented Nov 4, 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!


Boost plugin:

  • Next scheduled release: none scheduled.

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

@github-actions github-actions bot added [Plugin] Boost A feature to speed up the site and improve performance. [Tests] Includes Tests E2E Tests labels Nov 4, 2024
@tbradsha tbradsha marked this pull request as ready for review November 4, 2024 22:03
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.

Thanks, I've been meaning to look into this but have never gotten around to it.

For comparison, the similar .github/files/generate-ci-matrix.php script for our Tests workflow has a separate "artifact" property that it by default generates from the name and includes some tests to catch if anyone accidentally adds something with an invalid character.

@tbradsha tbradsha merged commit 7ae208e into trunk Nov 5, 2024
65 of 66 checks passed
@tbradsha tbradsha deleted the fix/tests/filename_conflict branch November 5, 2024 17:00
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 E2E Tests [Plugin] Boost A feature to speed up the site and improve performance. [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants