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

ci: add gulp e2e test #3318

Merged
merged 6 commits into from Aug 20, 2021
Merged

ci: add gulp e2e test #3318

merged 6 commits into from Aug 20, 2021

Conversation

Daniel-McCarthy
Copy link
Contributor

What's the problem this PR addresses?

The Gulp package is still missing from the list of completed E2E tests required by #368.

How did you fix it?

I added an E2E test that installs gulp to a project as a dev dependency and tests with two short scripts.
One creates a simple default task that should run successfully when running "gulp", validating that the dependency installed and is able to run.

The next creates a public task that can be run with the "gulp " CLI argument, and validates that we're able to import and use the gulp API by making use of the src() function to load the script file in.

I look forward to any suggestions for how to expand or improve E2E coverage for Gulp. Thanks for your time!

Checklist

  • I have set the packages that need to be released for my changes to be effective.
  • I will check that all automated PR checks pass before the PR gets reviewed.

Adds an E2E test for coverage and validation that Yarn berry is able to install gulp successfully and then verify it can be used successfully.

After installing gulp, a simple script is added to create a default gulp task that prints a statement. Running the gulp command runs the task, making sure the bare basic functionality is able to run.

Then, in order to make sure that we are able to import and use the gulp api, a test  is used to use the src function from gulp to load the script file that's running.
Also, it makes sure we can use gulp with a specific task name as well.

This should be a start to verifying gulp is installable with yarn and working as intended.
@merceyz
Copy link
Member

merceyz commented Aug 19, 2021

Ref gulpjs/gulp#2621

@merceyz merceyz changed the title Add E2E test to validate Gulp with Yarn ci: add gulp e2e test Aug 19, 2021
@arcanis
Copy link
Member

arcanis commented Aug 19, 2021

Nice, thanks! Interestingly the test seems to pass, unlike what gulpjs/gulp#2621 suggests 🤔 cc @bhanubais

Copy link
Member

@merceyz merceyz left a comment

Choose a reason for hiding this comment

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

Could you add a entry to the readme and compat table? See #2958 and #2983 for reference

Adds badge to display the status of Gulp E2E tests to the ReadMe alongside the rest.
Gulp is successfully running with Yarn berry from version 4 and up. This adds it to the compatibility list.
Yarn may potentially support earlier versions, but the E2E tests succeed for the 4 line, and not 3.91 and below due to varying issues.
@Daniel-McCarthy
Copy link
Contributor Author

Nice, thanks! Interestingly the test seems to pass, unlike what gulpjs/gulp#2621 suggests 🤔 cc bhanubais

No problem, just happy to find a way to help!

I was able to get this E2E test for 4.0.2 like mentioned in that issue as well as 4.0.0. If there's another edge case to cover for their workflow it will be interesting to see what the discrepancy is.

@arcanis arcanis merged commit 2036672 into yarnpkg:master Aug 20, 2021
@Daniel-McCarthy Daniel-McCarthy deleted the Gulp-E2E-Test branch September 2, 2021 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants