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.

Sign up for GitHub

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

Jump to bottom

Monorepo plugin #630

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Monorepo plugin #630

wants to merge 26 commits into from

Conversation

apaleslimghost
Copy link
Member

@apaleslimghost apaleslimghost commented Apr 24, 2024 •
edited
Loading

  • just exports a task. if you want to run commands in your workspace packages, run that task at the toplevel, and it will run the same command in the workspace

    example

    .toolkitrc.yml

    commands:
  test:local: WorkspaceCommand

    packages/something/.toolkitrc.yml

    commands:
  test:local: Cypress # only needed in this package

    npx dotcom-tool-kit test:local in the root runs test:local in packages/something, which runs Cypress

  • refactors some stuff in the core to expose some internals needed for the monorepo task → make tool kit config loading agnostic of CWD #709

  • collects workspace package command errors into an AggregateError to make use of the new(ish) AggregateError handling better error formatting  #716

@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from a617d77 to 456ce34 Compare May 9, 2024 08:58
ivomurrell
ivomurrell reviewed May 22, 2024
View reviewed changes
Copy link
Contributor

@ivomurrell ivomurrell left a comment

Choose a reason for hiding this comment

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

i'm very happy that this is so simple! though the proof is in the cp-content-pipeline pudding...

plugins/monorepo/package.json Show resolved Hide resolved
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch 2 times, most recently from b451dfb to 32c9c65 Compare July 25, 2024 11:30
@apaleslimghost apaleslimghost mentioned this pull request Jul 25, 2024
Merged
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 32c9c65 to 15d7b26 Compare July 25, 2024 13:41
@apaleslimghost apaleslimghost changed the base branch from next to create-plugin-fixes July 25, 2024 13:41
Base automatically changed from create-plugin-fixes to next July 25, 2024 13:42
@apaleslimghost apaleslimghost mentioned this pull request Jul 25, 2024
Merged
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 15d7b26 to 3c24d34 Compare July 25, 2024 13:47
@apaleslimghost apaleslimghost changed the base branch from next to task-context July 25, 2024 13:47
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch 2 times, most recently from 0e0ae70 to 5a89031 Compare July 25, 2024 16:02
@apaleslimghost apaleslimghost mentioned this pull request Jul 25, 2024
Merged
@apaleslimghost apaleslimghost changed the base branch from task-context to split-config-loading July 25, 2024 16:03
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 5a89031 to 52b4fc2 Compare July 29, 2024 11:26
@apaleslimghost apaleslimghost marked this pull request as ready for review October 1, 2024 13:13
@apaleslimghost apaleslimghost requested a review from a team as a code owner October 1, 2024 13:13
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 52b4fc2 to 4f9a816 Compare October 1, 2024 13:17
Base automatically changed from split-config-loading to main October 1, 2024 14:55
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 4f9a816 to 68a31e5 Compare November 4, 2024 11:07
@apaleslimghost apaleslimghost mentioned this pull request Nov 8, 2024
Merged
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from d2b5026 to 9a99482 Compare November 8, 2024 10:21
@apaleslimghost apaleslimghost changed the base branch from main to roots-manuva November 8, 2024 10:21
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 9a99482 to 66e744c Compare November 8, 2024 10:23
@apaleslimghost
feat: load workspace package tool kit configs
8b8c418
@apaleslimghost
feat: run workspace commands in parallel
33ab433
@apaleslimghost
refactor: use map instead of a for loop for runPackageCommand calls
23e33aa
@apaleslimghost
feat: allow overriding which command to run in the workspace via a ta…
7328ff0 
…sk option
@apaleslimghost
build: don't throw in generate-docs when no readme
875f6bd
@apaleslimghost
build: inherit volta config from root
e617775
@apaleslimghost
backstage: update monorepo plugin dependency versions
9dcf9c8
@apaleslimghost
docs(monorepo): add readme
d109a1c
@apaleslimghost
docs(monorepo): add high-level workflow explanation
98fb745
@apaleslimghost
docs(monorepo): document plugin vs npm run --workspaces considerations
7fb683d
@apaleslimghost
build: compile the monorepo plugin
de8ed39
@apaleslimghost
feat(monorepo): add a packageFilter option
170f67f
@apaleslimghost
docs: automatically regenerate schema docs
681a250
@apaleslimghost
feat: use an AggregateError for workspace package command errors
27dbe2a
@apaleslimghost
feat: pass cwd into init
0dbd7ea
@apaleslimghost
fix: run init before printing help
891ae01
@apaleslimghost
refactor: load workspace configs at init not task run
6315513
@apaleslimghost
feat: only attempt to run workspace command in packages that have it,…
ea7936e 
… and log which packages

(instead of logging a bunch of "no task configured for test:local: skipping assignment...")
@apaleslimghost
feat: print workspace package name in task run errors
1072966
@apaleslimghost
test: add basic test for LoadWorkspaceConfigs
b8225b2
@apaleslimghost
test: add tests for LoadWorkspaceConfigs failure behaviour
57fea91
@apaleslimghost
fix(typescript): resolve tsc path from cwd
fdc19ef
@apaleslimghost
fix: prevent running nodemon in non-root directories
81ebda7
@apaleslimghost
test(monorepo): strip ansi in snapshots
50b1606
@apaleslimghost
test: relative paths in snapshots (again)
3aacc49
@apaleslimghost
backstage: update package-lock.json
4d706d1
@apaleslimghost apaleslimghost force-pushed the monorepos-monorepos-monorepos branch from 2285d00 to 4d706d1 Compare December 16, 2024 17:27
@apaleslimghost apaleslimghost changed the base branch from main to pre-post-steps December 16, 2024 17:27
meel-io
meel-io approved these changes Dec 20, 2024
View reviewed changes
Copy link
Contributor

@meel-io meel-io left a comment

Choose a reason for hiding this comment

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

Tested it locally with a simple monorepo and worked perfectly 🎉 Easy to follow thanks to the nice comprehensive README

plugins/monorepo/readme.md
npm install --save-dev @dotcom-tool-kit/monorepo
```

Add the plugin to your [Tool Kit configuration](https://github.com/financial-times/dotcom-tool-kit/blob/main/readme.md#configuration):
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick: This link doesn't seem to show me the configuration section

plugins/monorepo/readme.md
Copy link
Contributor

Choose a reason for hiding this comment

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

praise: plus one

Base automatically changed from pre-post-steps to main December 20, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ivomurrell ivomurrell ivomurrell left review comments

@meel-io meel-io meel-io approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@apaleslimghost @meel-io @ivomurrell