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

Beta tech debt #111

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Beta tech debt #111

merged 4 commits into from
Sep 26, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Sep 26, 2024

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: # (issue, if applicable)

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

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 component registration process to utilize AuroLibraryRuntimeUtils for improved tag handling and update related documentation and demo files accordingly. Remove obsolete scripts to clean up the codebase.

Enhancements:

  • Refactor the component registration process to use the AuroLibraryRuntimeUtils for handling component tag renaming.
  • Update the import and registration of custom components in demo and documentation files to use RuntimeUtils.

Documentation:

  • Update documentation to reflect changes in the component registration process using RuntimeUtils.

Chores:

  • Remove unused scripts related to documentation generation and static styles.

@jordanjones243 jordanjones243 self-assigned this Sep 26, 2024
@jordanjones243 jordanjones243 requested a review from a team as a code owner September 26, 2024 17:01
Copy link

sourcery-ai bot commented Sep 26, 2024

Reviewer's Guide by Sourcery

This pull request focuses on refactoring the AuroBadge component to use a new AuroLibraryRuntimeUtils class for handling custom tag names and component registration. It also updates dependencies and removes some unused scripts.

Sequence Diagram

sequenceDiagram
    participant App
    participant RuntimeUtils
    participant AuroBadge
    participant CustomElements
    App->>RuntimeUtils: registerComponent('custom-badge', AuroBadge)
    RuntimeUtils->>CustomElements: define('custom-badge', AuroBadge)
    CustomElements-->>RuntimeUtils: Component registered
    RuntimeUtils-->>App: Registration complete
Loading

File-Level Changes

Change Details Files
Refactored custom tag name handling and component registration
  • Introduced AuroLibraryRuntimeUtils class for handling runtime operations
  • Replaced custom handleCustomTagName method with runtimeUtils.handleComponentTagRename
  • Updated component registration process to use RuntimeUtils.registerComponent
  • Removed registerComponent function from index.js
src/auro-badge.js
index.js
demo/index.html
demo/index.md
docs/partials/index.md
Updated dependencies and version numbers
  • Updated design-tokens version to 4.9.2
  • Updated webcorestylesheets version to 5.1.2
  • Removed buttonVersion.js and iconVersion.js files
README.md
src/buttonVersion.js
src/iconVersion.js
Modified styling variables
  • Updated --ds-auro-badge-container-color variable value
demo/api.md
Removed unused scripts
  • Deleted generateDocs.mjs
  • Deleted staticStyles-template.js
scripts/generateDocs.mjs
scripts/staticStyles-template.js

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.

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

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 @jordanjones243 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you provide more information about the removal of 'scripts/generateDocs.mjs' and 'scripts/staticStyles-template.js'? Were these functionalities moved elsewhere or are they no longer needed?
  • The color value change in demo/api.md from '#326aa5' to '#265688' - was this intentional? If so, is it related to an update in design tokens?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue 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 to tell me if it was helpful.

demo/api.md Show resolved Hide resolved
@jordanjones243 jordanjones243 merged commit 3244279 into beta Sep 26, 2024
4 checks passed
@jordanjones243 jordanjones243 deleted the betaTechDebt branch September 26, 2024 17:03
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

2 participants