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

Jbaker/beta release #206

Merged
merged 12 commits into from
Oct 4, 2024
Merged

Jbaker/beta release #206

merged 12 commits into from
Oct 4, 2024

Conversation

jason-capsule42
Copy link
Member

@jason-capsule42 jason-capsule42 commented Oct 4, 2024

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Refactor the auro-select component to use dynamic tag generation for auro-dropdown, introduce a new versioning system for dependency components, and enhance theming capabilities. Update documentation and tests to reflect these changes, and clean up deprecated scripts and configurations.

New Features:

  • Introduce a new versioning system for generating unique names for dependency components using AuroDependencyVersioning.

Enhancements:

  • Refactor the auro-select component to use dynamic tag generation for auro-dropdown, improving flexibility and reducing hardcoded dependencies.
  • Update styles to include additional CSS files for color and tokens, enhancing the component's theming capabilities.
  • Replace the custom component registration method with a new approach using RuntimeUtils for better integration and version conflict management.

Documentation:

  • Add documentation on theme support, providing guidance on how to restyle the component using design tokens.

Tests:

  • Update tests to accommodate the refactored auro-dropdown tag selection, ensuring compatibility with the new dynamic tag generation.

Chores:

  • Remove deprecated husky script and update the ESLint configuration to a new format using a flat config file.

jordanjones243 and others added 12 commits October 4, 2024 12:07
* implement tier 3 color tokens [#198](#198) ([c5940e7](c5940e7))

* move help text functionality into dropdown slot ([8607c0f](8607c0f))
* update dependencies and scripts to latest versions ([f40f971](f40f971))
* use custom version of dropdown ([617c8f7](617c8f7))
BREAKING CHANGE: trigger major release for color theme support #198
# [3.0.0-beta.1](v2.11.0-beta.1...v3.0.0-beta.1) (2024-10-03)

### Bug Fixes

* add extension for SSR support ([2b5ee5a](2b5ee5a))

### Performance Improvements

* refactor custom component registration config ([7dbb9c3](7dbb9c3))
* update dependencies ([19dfb75](19dfb75))

### BREAKING CHANGES

* trigger major release for color theme support #198
@jason-capsule42 jason-capsule42 requested a review from a team as a code owner October 4, 2024 19:13
@jason-capsule42 jason-capsule42 self-assigned this Oct 4, 2024
Copy link

sourcery-ai bot commented Oct 4, 2024

Reviewer's Guide by Sourcery

This pull request implements several changes to the auro-select component, including updating dependencies, refactoring code for better performance and maintainability, and adding new features such as theme support and placeholder text color customization.

Updated class diagram for AuroSelect component

classDiagram
    class AuroSelect {
        - runtimeUtils: AuroLibraryRuntimeUtils
        - dropdownTag: String
        + configureDropdown()
        + updateDisplayedValue(option)
        + performUpdate()
    }
    class AuroLibraryRuntimeUtils
    class AuroDependencyVersioning {
        + generateTag(componentName, version, component)
    }
    AuroSelect --> AuroLibraryRuntimeUtils
    AuroSelect --> AuroDependencyVersioning
    AuroSelect --> AuroDropdown
    AuroDependencyVersioning --> AuroDropdown
    AuroSelect : +styles = [styleCss, colorCss, tokensCss]
Loading

File-Level Changes

Change Details Files
Refactored auro-select component for better performance and maintainability
  • Introduced AuroDependencyVersioning for generating unique tags
  • Updated dropdown selection to use the new tag system
  • Refactored dropdown attribute setting for improved performance
  • Moved help text and error message template inside the dropdown component
src/auro-select.js
Updated styles and added theme support
  • Removed background color from select element
  • Moved hover styles to a new color.scss file
  • Added tokens.scss file for theme customization
  • Updated styles to use new CSS custom properties
src/style.scss
src/color.scss
src/tokens.scss
Updated component registration and import process
  • Replaced custom registerComponent function with RuntimeUtils method
  • Updated import statements in demo and test files
index.js
demo/index.html
test/auro-select.test.js
Added ESLint configuration and updated dependencies
  • Added eslint.config.mjs file
  • Updated dependency versions in README.md
eslint.config.mjs
README.md
Updated documentation and demo files
  • Updated API documentation to include theme support information
  • Modified description of the component in various files
  • Updated usage examples in documentation
demo/api.md
docs/partials/api.md
docs/partials/description.md
docs/partials/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ jason-capsule42
✅ jordanjones243
❌ semantic-release-bot
You have signed the CLA already but the status is still pending? Let us recheck it.

@jason-capsule42 jason-capsule42 linked an issue Oct 4, 2024 that may be closed by this pull request
2 tasks
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jason-capsule42 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 3 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

test/auro-select.test.js Show resolved Hide resolved
docs/partials/index.md Show resolved Hide resolved
docs/partials/api.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit a674712 into main Oct 4, 2024
12 of 13 checks passed
@jason-capsule42 jason-capsule42 deleted the jbaker/betaRelease branch October 4, 2024 19:17
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 4, 2024
@jordanjones243 jordanjones243 mentioned this pull request Oct 4, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update color tokens for theming support
5 participants