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

feat: updated scaffolding, new project & user banners, ability to remove scaffolding #15826

Merged
merged 72 commits into from Jun 22, 2021

Conversation

panzarino
Copy link
Contributor

@panzarino panzarino commented Apr 6, 2021

Adds some of the functionality (or equivalent) mentioned in #3364, given this work + CT CLI might be time to close that issue?

Updated scaffolding changes implemented in cypress-io/cypress-example-kitchensink#481

User facing changelog

List of things in this PR that could be mentioned in changelog:

  • Updates initial scaffolding to include example tests for TodoMVC
  • Removes existing onboarding modal for new project
  • Adds onboarding banners with helpful links for new users and new projects
  • Adds ability to easily remove scaffolded integration tests when a new project is created
  • Added ability to create a new file from the UI when no files are found

Not sure if we need to include specifics around the modal/banners - we could probably just consolidate to improved first time / new project onboarding experience

Additional details

For removing files, we only remove files that came from our scaffolding and were not modified (compares by name, filesize) to ensure that users do not loose any of their work.

The new user banner will only appear the first time that someone uses Cypress if they're joining an existing project. The new project banner will appear on every new project.

Updated kitchen sink has been deployed

How has the user experience changed?

Here's a gif showing the new project banner as well as deleting the example files and the updated "no files found" screen

Screen-Recording-2021-05-19-at-1

Here's what the new user banner looks like (joining an existing project)

Screen Shot 2021-05-19 at 19 34 02

PR Tasks

  • Have tests been added/updated?
  • Has the original issue or this PR been tagged with a release in ZenHub?
  • Has a PR for user-facing changes been opened in cypress-documentation?
  • Have API changes been updated in the type definitions?
  • Have new configuration options been added to the cypress.schema.json?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Apr 6, 2021

Thanks for taking the time to open a PR!

@cypress
Copy link

cypress bot commented Apr 6, 2021



Test summary

12336 0 153 5Flakiness 0


Run details

Project cypress
Status Passed
Commit c60654a
Started Jun 22, 2021 1:19 PM
Ended Jun 22, 2021 1:30 PM
Duration 11:24 💡
OS Linux Debian - 10.8
Browser Multiple

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@panzarino panzarino changed the title fix: update and simplify initial scaffolding fix: update initial scaffolding Apr 13, 2021
@panzarino panzarino changed the title fix: update initial scaffolding feat: update initial scaffolding and add ability to remove scaffolding Apr 22, 2021
@panzarino panzarino changed the title feat: update initial scaffolding and add ability to remove scaffolding feat: update scaffolding, new project & user banners, ability to remove scaffolding Apr 23, 2021
@jennifer-shehane jennifer-shehane self-requested a review June 17, 2021 21:10
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

@panzarino So, this seems to have really broken the initial scaffolding of files on Windows.

I attached a photo of what is scaffolded. This seems really weird. Where is this eha directory even coming from??

We've had reports of like, weird scaffolding before on Windows (I'd have to find them). So I thought maybe I did something unusual. But I made sure to switch to develop to confirm that it doesn't happen on develop.

Screen Shot 2021-06-21 at 8 36 08 AM

I would suggest setting up a VM at this point - if only to have 2 people verify the behavior and isolate whether it's a local issue or not. It will also close the loop on work + review so this can get done quicker. Sorry. :(

@panzarino
Copy link
Contributor Author

@jennifer-shehane Yeah I had a feeling that the initial scaffolding would break with some of the changes that I just introduced - I've reverted those and kept some of the removal changes so hopefully everything works properly now.

I'm working on setting up a VM so that I can test on my own - thanks for being so patient and testing this on Windows so many times already.

Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

@panzarino The scaffolding is fixed now, but after confirming to delete the files - the files are not deleting on Windows.

@panzarino
Copy link
Contributor Author

@jennifer-shehane Thought that might happen - I have slow internet so I'm unable to download Windows for a VM in a realistic timeframe. I'm currently testing through appveyor and looking at the test results there to hopefully get it to work - once the unit tests pass on windows I imagine it would work properly in practice

@jennifer-shehane
Copy link
Member

@panzarino K, let me know when you want me to run again. Setting up a VM will take a long time.

@panzarino
Copy link
Contributor Author

@jennifer-shehane So I believe that I've finally actually fixed the problem - I've gotten all remove scaffolding unit tests to pass on appveyor so I'm confident that it'll actually work in manual testing.

@jennifer-shehane jennifer-shehane self-requested a review June 22, 2021 15:27
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

@panzarino Seems to be working now on Windows + Mac. Looks like it will make it in this release. 👍

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jun 23, 2021

Released in 7.6.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v7.6.0, please open a new issue.

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators Jun 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants