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

Refactor bootstrap+sandbox into "task" framework #19275

Merged
merged 85 commits into from
Oct 10, 2022

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Sep 28, 2022

Refactor sandbox into yarn task so that it is all of one piece. In particular:

  • Remove yarn sandbox turning it into the sandbox task
  • Remove yarn bootstrap and ./bootstrap.sh turning them into the compile task
  • Documented the above changes and the new recommended workflow

As documented

  • yarn start will:
    • Install in code
    • Install in scripts
    • Run the Vite TS sandbox
  • yarn task will:
    • Install in scripts
    • Prompt for the task you want to run.

Note that yarn task only installs in code if you choose the install task. If you've never installed, this will definitely happen, but if your install is out of date, this might trip you up. This is documented.

I've tried to get as many places we referenced bootstrap as possible but I'm sure I've missed things. We will definitely need to do more cleanup once we've finished deleting examples.

@shilman shilman added the maintenance User-facing maintenance tasks label Sep 28, 2022
@tmeasday tmeasday marked this pull request as ready for review October 3, 2022 06:35
.yarnrc.yml Show resolved Hide resolved
@ndelangen
Copy link
Member

ndelangen commented Oct 10, 2022

@tmeasday This PR will fix up the cra bench for you:
#19416 (merged)

@ndelangen
Copy link
Member

@tmeasday This will fix the netlify check:
#19418

@ndelangen
Copy link
Member

@tmeasday I think we could/should change the way we invoke the task from:

yarn task --task compile

to:

yarn task compile

@ndelangen
Copy link
Member

I also opened a PR to remove the duplicate yarn installation:
#19417

@tmeasday
Copy link
Member Author

@ndelangen

@tmeasday I think we could/should change the way we invoke the task from:

I agree but I kind of want to merge this. Perhaps a follow up PR later? I was thinking to change the options mechanism to allow certain "positional" options. But we'd also need to tweak all the docs etc.

@tmeasday
Copy link
Member Author

I also opened a PR to remove the duplicate yarn installation:

@ndelangen I ended up doing that in this PR too:cbead1a

@tmeasday
Copy link
Member Author

Oh I see you did something different.

@tmeasday tmeasday merged commit 8390970 into next Oct 10, 2022
@tmeasday tmeasday deleted the tom/sb-628-properly-document-maintenance-scripts branch October 10, 2022 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants