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

[Theme] Base theme setup #8030

Merged

Conversation

mgadewoll
Copy link
Contributor

@mgadewoll mgadewoll commented Sep 19, 2024

Summary

closes #124

Important

This PR is currently still in Draft mode, as it needs alignment on some package/dependency specific setups/architectural choices.

📖 See additional information here.

QA

  • checkout this PR and verify packages build and run as expected:
    • /eui: run build:workspaces to build workspace dependencies then check that our common development tools/scripts work as expected
      • Storybook: yarn storybook and yarn build-storybook
      • EUI docs: yarn start and yarn build-docs
    • /website: run build:workspaces and then test that EUI+ docs works as expected via yarn start and yarn build

Deployments & theme switcher testing

By default the theme switcher is only enabled for development environments.

Storybook: https://eui.elastic.co/pr_8030/storybook/?path=/story/navigation-euibutton--playground
EUI docs: https://eui.elastic.co/pr_8030/
EUI+: https://eui.elastic.co/pr_8030/new-docs/

@mgadewoll mgadewoll force-pushed the eui-theme/124-add-new-theme branch 2 times, most recently from cd61810 to d19f6c1 Compare September 19, 2024 14:24
@elastic elastic deleted a comment from elasticmachine Sep 19, 2024
@mgadewoll mgadewoll force-pushed the eui-theme/124-add-new-theme branch 8 times, most recently from ab1ae64 to 1596ae7 Compare September 23, 2024 13:50
@mgadewoll mgadewoll changed the base branch from main to eui-theme/borealis October 8, 2024 15:52
@mgadewoll mgadewoll changed the title [DO NOT MERGE][DRAFT] Base theme setup [Theme] Base theme setup Oct 8, 2024
@@ -253,6 +256,8 @@
},
"peerDependencies": {
"@elastic/datemath": "^5.0.2",
"@elastic/eui-theme-borealis": "0.0.1",
"@elastic/eui-theme-common": "0.0.1",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ℹ️ The theme-common package is added as peerDependency for now while it's not actually released yet. Once released we should add it as actual dependency.

@@ -16,8 +16,9 @@
],
"scripts": {
"start": "cross-env BABEL_MODULES=false webpack serve --config=src-docs/webpack.config.js",
"build:workspaces": "yarn workspaces foreach -Rti --from @elastic/eui-theme-common run build && yarn workspaces foreach -Rti --from @elastic/eui --exclude @elastic/eui --exclude @elastic/eui-theme-common run build",
Copy link
Contributor Author

@mgadewoll mgadewoll Oct 9, 2024

Choose a reason for hiding this comment

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

❓ I'm wondering if we want to move this also to the root of our monorepo to have a global script to run initially similar to yarn, Wdyt?

"license": "SEE LICENSE IN LICENSE.txt",
"scripts": {
"build:clean": "rimraf lib/",
"build": "yarn build:clean && yarn build:compile && yarn build:compile:cjs && yarn build:types",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ℹ️ Currently there are no watchers setup yet to listen to changes in these standalone packages. That means that - for now - we need to manually update when e.g. running Storybook or docs.
This should be added for devX but is likely going to happen as a follow-up task.

@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 14, 2024

💔 Build Failed

Failed CI Steps

History

@tkajtoch tkajtoch marked this pull request as ready for review October 22, 2024 14:04
@tkajtoch tkajtoch requested a review from a team as a code owner October 22, 2024 14:04
Copy link
Member

@tkajtoch tkajtoch left a comment

Choose a reason for hiding this comment

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

I reviewed the code again and ran all common scripts locally to ensure they're all working.

As we already discussed, the changes look great! I don't have any objections, especially considering this is going to be merged to a feature branch.

@mgadewoll mgadewoll merged commit c2cc86c into elastic:eui-theme/borealis Oct 23, 2024
4 checks passed
mgadewoll added a commit that referenced this pull request Oct 23, 2024
tkajtoch pushed a commit that referenced this pull request Oct 31, 2024
mgadewoll added a commit that referenced this pull request Nov 8, 2024
mgadewoll added a commit that referenced this pull request Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants