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

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

Merged
merged 7 commits into from
Jun 10, 2024

Conversation

andy-blum
Copy link
Member

@andy-blum andy-blum commented May 22, 2024

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 chore(build): replace node-sass with sass #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
Copy link
Collaborator

motou commented May 22, 2024

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
Copy link
Member Author

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

@m4olivei
Copy link
Contributor

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
Copy link
Contributor

This is working for me locally. Lets see how it does in CI: #318

@m4olivei
Copy link
Contributor

CI is clean over in #318 🙌

Copy link
Collaborator

@motou motou left a comment

Choose a reason for hiding this comment

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

Please also check if lerna config needs to be adjusted

@andy-blum
Copy link
Member Author

@motou you mean the lerna.json file?

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

What would need changed?

@motou
Copy link
Collaborator

motou commented May 23, 2024

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

@motou
Copy link
Collaborator

motou commented May 23, 2024

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.

@andy-blum andy-blum requested a review from motou June 10, 2024 14:43
@motou motou merged commit 3364c93 into carbon-design-system:base Jun 10, 2024
1 check passed
motou added a commit that referenced this pull request Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants