chore(demo-site): remove demo site package

carbon-design-system / devtools

A simple set of tools for teams building live Carbon pages.

http://ibm.biz/carbon-devtools

Apache License 2.0

43 stars 18 forks source link

chore(demo-site): remove demo site package #316

Closed andy-blum closed 3 months ago

andy-blum commented 3 months ago

[!NOTE] This PR is a part of my exploration into the devtools to understand how they work, how to update them for use with the next version of Carbon and carbon-based libraries, and how to make them more maintainable going forward. Full documentation is available here (w3ID required)

This PR removes the demo-site package, for several reasons:

The package appears to no longer function correctly, as running the yarn commands fails to start up the next.js app in any meaningful way.
The package has not had a commit since #261, nearly 2 years ago.
The public version of this package, https://carbon-design-system.github.io/devtools/, is built from this repository's gh-pages branch which appears to be just a static build.
Adding the web-ext package would allow us to test the extension against live sites easily

Changelog

Removed

Removes the demo-site package

motou commented 3 months ago

Thanks Andy for raising the PR. Please take a look at the failed PR checks. It seems that the web extension cannot be built now.

andy-blum commented 3 months ago

Been digging into that - it's definitely still building locally on the same versions of node & npm.

m4olivei commented 3 months ago

I can reporduce the issue locally. Seems to be an order of operations thing. The build fails on Error: Can't resolve '@carbon/devtools-component-list/dist/index.json'. That file is only created once you've run yarn build on the packages/component-list package. If I do that first, and then yarn build the entire project, all is well.

This same issue is present on the base branch. It's maybe just a matter of declaring the dependency on @carbon/devtools-component-list from carbon-devtools?

m4olivei commented 3 months ago

This is working for me locally. Lets see how it does in CI: https://github.com/carbon-design-system/devtools/pull/318

m4olivei commented 3 months ago

CI is clean over in https://github.com/carbon-design-system/devtools/pull/318 🙌

andy-blum commented 3 months ago

@motou you mean the lerna.json file?

{
  "version": "2.3.3",
  "npmClient": "yarn",
  "useWorkspaces": true
}

What would need changed?

motou commented 3 months ago

Yes, we may need to remove the workspaces that are already removed

motou commented 3 months ago

On the other side, if the demo site is removed, please provide a website that uses Carbon v10 in the readme file so that the dev tools can be triggered.