New contributor workflow #1792

dac09 · 2021-02-13T17:13:18Z

Introduces new contributor workflow (without removing old copy:watch flow)

In order to contribute from a project now, you simply need to run

yarn rwt link [RW_PATH]

This will ask to setup your workspaces, and create the symlink for you. It willl also build and watch the redwood repo, so no need to build using another separate terminal session.

Once you're done, and you want to restore, you run

yarn rwt restore

Need input

Is rwt link intuitive? Or should we call it something else? This is meant to be like npm link, yarn link
Improve the messaging, maybe use boxen to explain?
rwt restore -> rwt unlink? I don't like unlink for some reason
On my machine, in the redwood repo it creates a symlink inside packages. So packages/packages - no idea why!

Other benefits

I think it consumes less cpu (one less watcher)
You can install / yarn rw setup stuff, without breaking the contribution workflow
Cleans up the redwood-tools.js file to make it easier to wrangle the code
Fixes infinite loop that sometimes happens building eslint-plugin
Fixes configs (webpack, etc.) not being available on the project until save. Since it's using symlinks, we don't have to worry about rebuilding!
We don't need to worry about manually installing new dependencies when using canary (just remember to yarn in your redwood repo)

Preview of what it looks like:
https://s.tape.sh/NSEQV6FH

github-actions · 2021-02-13T17:17:46Z

📦 PR Packages

Click to Show Package Download Links

Install this PR by running yarn rw upgrade --pr 1792:0.25.1-82ea6f7

jtoar · 2021-02-13T20:53:06Z

@dac09 super excited to try this out! Confirming the steps are:

create a new Redwood app and upgrade to this PR with yarn rw upgrade --pr 1792:0.25.0-6b66c9f
still in that redwood app, run yarn rwt link [RW_PATH]
say yes to the prompt
see edits from your local copy of the redwood repo live in the redwood app?

Here's a tape of me trying out a new setup command I'm working on. The repo doesn't seem to pick it up. Did I miss anything obvious? https://s.tape.sh/aIoTMMq2

dac09 · 2021-02-13T22:22:22Z

Your process Looks fine to me Dom! Not sure why it's not coming through. Could you try:
a) yarn in the root of your project
b) Is there a soft link called "redwood" in the root of your project?

jtoar · 2021-02-13T23:39:17Z

Tried yarn in the root and still no luck, but that soft link is there. Maybe it has to do with adding a new CLI command? I can try making changes to another part of the framework, like the router, and see if they propagate.

dac09 · 2021-02-14T00:53:23Z

Weird. I've been using this to test itself (does that make any sense?!) Probably missed something. I'll try it out more on Monday!

dac09 · 2021-02-15T14:00:33Z

Ah, I can see why. When you build using the PR flow, it adds @rw/cli to your dev dependencies. For some reason this takes precedence over your locally linked packages. Once I removed this dependency form package.json and yarn'd, it all came through fine :) https://s.tape.sh/zfsZSxa6

Tldr; this is difficult to test with the PR flow. Steps

Run upgrade PR command
Run yarn rwt link [PATH] once, so it adds the symlink, etc. for you
Remove @redwoodjs/cli from your dev dependencies in package.json (created by the pr upgrade thingy)
If you don't have this branch checked out on your redwood repo, run: chmod +x node_modules/.bin/rwt && chmod +x node_modules/.bin/rw
yarn rwt link [PATH] again.

If/once this is part of the redwood releases, you'll only need to run step 2.

Edit: updated based on comments below

jvanbaarsen · 2021-02-15T14:16:25Z

@dac09 This is great! Would make the experience so much better :) Are there certain cases you'd like people to test?

jtoar · 2021-02-15T16:53:17Z

@dac09 Those steps worked great! One thing I wanted to add: at the end you'll most likely have to make the rw binary executable again using chmod +x ./node_modules/.bin/rw.

jvanbaarsen · 2021-02-15T18:02:23Z

@dac09 Just tested this locally works great! It's important to keep in mind the devDependency indeed (Would this be a problem when people upgraded their local repo with a PR upgrade?) One thing to note as @jtoar said, every time the thing did a rebuild you need to chmod the rw binary.

dac09 · 2021-02-15T18:04:00Z

I definitely added the chmod inside the watcher... so everytime cli, apiserver and devserver builds, they get chmodded. I wonder why they hadn't in this case?

jvanbaarsen · 2021-02-15T18:18:27Z

@dac09 You chmod dist/index.js, not the actual rw executable. Can that be the problem?
--edit: Nvm.. Didn't look correctly

dac09 · 2021-02-15T18:20:21Z

OH! I know why. It's because the changes to the build folder also need to be checked out in your local redwood repo LOL.

This is so meta!

So without the changes to the build process in your local repo, it won't chmod automatically :)

jvanbaarsen · 2021-02-15T18:21:52Z

@dac09 I was just about to post that 🙈 I'll double check this assumption with checkout out this PR in my RW reop.

dac09 · 2021-02-15T18:24:01Z

Headsup 👒, I just rebased my branch. Now added --clean flag.

@jvanbaarsen, @jtoar any chance you guys can see why

On my machine, in the redwood repo it creates a symlink inside packages. So packages/packages - no idea why!

jvanbaarsen · 2021-02-15T18:25:54Z

@dac09 Your assumption was right! After checking out this PR as my RW base it works like a charm :) Also seeing the packages/packages thing though

jvanbaarsen · 2021-02-15T18:32:50Z

@dac09 Can it be that because you're linking packages into ./redwood and you then build again it kinda gets in a loop? So it keeps trying to create a folder packages inside of packages? (But since you cannot have a symlink in another symlink you just get one?)

dac09 · 2021-02-15T18:45:09Z

I don't htink so @jvanbaarsen, the build is running in the redwood repo, not the actual project (cwd is set to frameworkPath).

You can also do each of those steps manually, the function really isn't doing anything special.

jvanbaarsen · 2021-02-15T19:03:30Z

@dac09 What is the reason packages/* is added to the project package.json?

--edit: Nevermind, that is something new that is added in the newest release

jvanbaarsen · 2021-02-15T19:34:30Z

@dac09 I got the problem I think :-) We need to add a check to see if the symlink is already present. If that is the case we should not create it. You can verify this assymption by removing the symlink, and then run this twice:

ln -sf YOUR_REDWOOD_REPO/packages ./redwood

jtoar · 2021-02-18T16:52:04Z

@jvanbaarsen probably just a limitation of the way I work, I'm used to making changes in one place then context switching to the other, so I don't feel like I need to copy:watch, I just copy when I'm ready. But the watch workflow's probably something I can adapt to. Do you do anything differently or is it really just work, save, switch?

dac09 · 2021-02-18T16:53:16Z

I can add a flag so you can run yarn rwt l --watch false ? @jtoar

Tobbe · 2021-02-18T16:57:57Z

I ran into issues last time I tried cpw in Windows. Something about files being in use by another process. But when I tried yesterday with link I didn't get that error.

Should the flag be --no-watch?

dac09 · 2021-02-18T17:00:01Z

Although I've added no-xxx as flags before, I think that its better than we just use a boolean to control these flags. With the defaults being true, for sensible defaults (e.g. clean, watch).

dac09 · 2021-02-18T17:01:17Z

Btw - I've added to the added benefits section, I've found more cases where this can be useful!

…rib-workspaces * 'main' of github.com:redwoodjs/redwood: Prerender Part 1 & 2: Render landing/marketing/static pages + Private page whileLoading (redwoodjs#1641)

jvanbaarsen · 2021-02-18T18:34:19Z

@Tobbe I believe. if you have a boolean value for watch, you get --no-watch for free.

@jtoar Yeah for me it is make a change in the Redwood repo, switch to test project and see if the change worked, the less steps the better for me :)

Tobbe · 2021-02-18T18:51:30Z

@Tobbe I believe. if you have a boolean value for watch, you get --no-watch for free.

Yeah, I think you're right, yargs does that, doesn't it? 👍

dac09 · 2021-02-18T18:52:55Z

@Tobbe I believe. if you have a boolean value for watch, you get --no-watch for free.

#TIL!

jvanbaarsen · 2021-02-18T19:22:16Z

@Tobbe Yes! I actually got tripped up by this after someone created an issue with the --no-watch flag for the rw test command. I was about to open a PR to document that behaviour until I noticed it is something that is given for free by yargs.

jvanbaarsen · 2021-02-20T20:55:34Z

@dac09 What is currently holding us back in merging this? Is there anything I can do to speed this up a bit more?

dac09 · 2021-02-20T22:10:57Z

Just trying to minimise changes going into the release :)

dac09 · 2021-02-20T22:13:38Z

@jvanbaarsen I also noticed this failing when I try it using canary. Something about the svgo binary not found (introduced in prerender image handling with Babel-plugin-inline-svg). Could you please see if you face the same problem?

jvanbaarsen · 2021-02-22T08:28:30Z

@dac09 I was just about to test this and then realised I'm unsure what you mean with Canary? You either use Canary or the PR release right? There is no way to use both of them at the same time?

…rib-workspaces * 'main' of github.com:redwoodjs/redwood: Lint the create-redwood-app template. (redwoodjs#1822) Update typescript lint rule for no-unused-vars (redwoodjs#1808) Router: Fix TS types (redwoodjs#1823) Generate globals for routes (redwoodjs#1744) Ethereum auth update to v0.2.1 (redwoodjs#1807) Better messages when no routes marked with prerender (redwoodjs#1821) Feature/prerender image support (redwoodjs#1721) Fix entry js | Make index a little more readable, as it confuses people (redwoodjs#1819) use 'prisma' in place of '@prisma/cli' (redwoodjs#1800)

dac09 · 2021-02-22T12:44:19Z

Hey @jvanbaarsen sorry for not being clear! I've just updated the branch (merging main into this).

What we'll need to test is the latest PR build (once its updated).

dac09 · 2021-02-22T13:42:58Z

@thedavidprice think this is ready for prime time. Shall we get it into 0.26? Docs are covered here: #1803

thedavidprice

I'm not able to get this working using the instructions provided by @dac09 in this comment.

I can get the initial yarn rwt link ... to run. But not commands. I'm also seeing endless build:watch process:

Screen.Recording.2021-02-22.at.4.19.27.PM.mov

Tobbe · 2021-02-23T08:27:30Z

@thedavidprice I think you need to have your rw framework checked out to @dac09's branch (At least that's what I had to do to fix the build loop)

git checkout -b dac09-feature/contrib-workspaces main
git pull https://github.com/dac09/redwood.git feature/contrib-workspaces

dac09 · 2021-02-23T10:23:00Z

@thedavidprice as Tobbe said, the infinite loop is caused by an existing bug in the build process. (Try this on any other branch, yarn build:clean && yarn build:watch in the redwood repo. The infinite loop is also fixed on this PR, so unless you have this branch checked out in your redwood repo, it'll infinite loop.

… fix/dm-babel-register * 'fix/dm-babel-register' of github.com:dac09/redwood: Remove bundlesize dependency (redwoodjs#1844) upgrade execa; fix test.js cwd (redwoodjs#1846) Make ESLint configuration aware of "env." (redwoodjs#1827) Use createMany in Seed database example (redwoodjs#1776) Docs: Update contributor workflow to yarn rwt link (redwoodjs#1803) fix(page-loader): Adds types for pageLoadingContext | Fix for pageLoader during prerender (redwoodjs#1832) Minify CSS in production builds (redwoodjs#1697) New contributor workflow (redwoodjs#1792) Improve/template and auth setup tests (redwoodjs#1834)

dac09 added the topic/ops-&-contributing-dx label Feb 13, 2021

dac09 requested review from peterp and thedavidprice February 13, 2021 17:13

dac09 force-pushed the feature/contrib-workspaces branch from 677afa4 to 6b66c9f Compare February 13, 2021 17:18

dac09 added 4 commits February 15, 2021 17:18

Add contrib command

8635da2

WIP: Fix permissions thingy

81263ce

WIP

fef6c3f

Working ✨

286e6df

Fix infinite build loop in eslint plugin

1453ba8

Clean before build:watch

9808dbc

dac09 force-pushed the feature/contrib-workspaces branch from 6b66c9f to 9808dbc Compare February 15, 2021 18:22

dac09 added 2 commits February 18, 2021 17:44

Merge branch 'main' of github.com:redwoodjs/redwood into feature/cont…

1d8179d

…rib-workspaces * 'main' of github.com:redwoodjs/redwood: Prerender Part 1 & 2: Render landing/marketing/static pages + Private page whileLoading (redwoodjs#1641)

Rename restore to unlink | Add flag to disable watching

cb71eda

dac09 added 2 commits February 22, 2021 12:42

Regenerate lockfile

25ce4e6

dac09 added the next release label Feb 22, 2021

Merge branch 'main' into feature/contrib-workspaces

a170adc

thedavidprice requested changes Feb 23, 2021

View reviewed changes

Merge branch 'main' into pr/1792

82ea6f7

thedavidprice approved these changes Feb 23, 2021

View reviewed changes

thedavidprice merged commit dd17d24 into redwoodjs:main Feb 23, 2021

thedavidprice added this to the next release milestone Feb 23, 2021

dac09 deleted the feature/contrib-workspaces branch February 23, 2021 17:25

New contributor workflow #1792

New contributor workflow #1792

Conversation

dac09 commented Feb 13, 2021 • edited Loading

Need input

Other benefits

github-actions bot commented Feb 13, 2021 • edited Loading

📦 PR Packages

jtoar commented Feb 13, 2021

dac09 commented Feb 13, 2021

jtoar commented Feb 13, 2021

dac09 commented Feb 14, 2021 • edited Loading

dac09 commented Feb 15, 2021 • edited Loading

jvanbaarsen commented Feb 15, 2021

jtoar commented Feb 15, 2021

jvanbaarsen commented Feb 15, 2021

dac09 commented Feb 15, 2021

jvanbaarsen commented Feb 15, 2021 • edited Loading

dac09 commented Feb 15, 2021 • edited Loading

jvanbaarsen commented Feb 15, 2021

dac09 commented Feb 15, 2021

jvanbaarsen commented Feb 15, 2021

jvanbaarsen commented Feb 15, 2021

dac09 commented Feb 15, 2021

jvanbaarsen commented Feb 15, 2021 • edited Loading

jvanbaarsen commented Feb 15, 2021

jtoar commented Feb 18, 2021

dac09 commented Feb 18, 2021 • edited Loading

Tobbe commented Feb 18, 2021

dac09 commented Feb 18, 2021 • edited Loading

dac09 commented Feb 18, 2021

jvanbaarsen commented Feb 18, 2021

Tobbe commented Feb 18, 2021

dac09 commented Feb 18, 2021

jvanbaarsen commented Feb 18, 2021

jvanbaarsen commented Feb 20, 2021

dac09 commented Feb 20, 2021

dac09 commented Feb 20, 2021

jvanbaarsen commented Feb 22, 2021

dac09 commented Feb 22, 2021

dac09 commented Feb 22, 2021

thedavidprice left a comment

Choose a reason for hiding this comment

Tobbe commented Feb 23, 2021 • edited Loading

dac09 commented Feb 23, 2021

dac09 commented Feb 13, 2021 •

edited

Loading

github-actions bot commented Feb 13, 2021 •

edited

Loading

dac09 commented Feb 14, 2021 •

edited

Loading

dac09 commented Feb 15, 2021 •

edited

Loading

jvanbaarsen commented Feb 15, 2021 •

edited

Loading

dac09 commented Feb 15, 2021 •

edited

Loading

jvanbaarsen commented Feb 15, 2021 •

edited

Loading

dac09 commented Feb 18, 2021 •

edited

Loading

dac09 commented Feb 18, 2021 •

edited

Loading

Tobbe commented Feb 23, 2021 •

edited

Loading