Release Beta to Main #130

jason-capsule42 · 2024-08-20T17:11:40Z

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: #112, #124, #128

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

Add support for custom SVG icons and new icon styles, enhance theme support, and update documentation and tests accordingly.

New Features:

Introduce support for custom SVG icons using the customSvg attribute, allowing users to render any SVG content within the auro-icon component.
Add new icon styles including info, secondary, subtle, and tertiary to enhance visual customization options.

Enhancements:

Deprecate the primary icon style in favor of more specific styles.
Enhance theme support by allowing the component to be restyled using design tokens, improving customization capabilities.

Documentation:

Update documentation to include examples and usage of the new customSvg attribute and additional icon styles.
Add a section on theme support, detailing how to restyle the component using design tokens.

Tests:

Add tests to verify the registration of auro-icon as a custom element with a custom name.
Remove outdated tests related to the advisory style and update tests to reflect the new icon styles and attributes.

This commit address the following updates: 1. add component level tokens for theming 2. Advisory variant has been removed. Warning variant is the intended replacement. 3. add classmap for label attribute 4. add customSvg attribute support #124 Changes to be committed: modified: README.md new file: apiExamples/customSvg.html modified: apiExamples/onDark.html modified: apiExamples/visualState.html new file: demo/alaska.html modified: demo/alaska.md modified: demo/api.md modified: docs/api.md modified: docs/partials/api.md modified: index.js modified: package-lock.json modified: package.json modified: src/auro-icon.js modified: src/baseIcon.js new file: src/color.scss deleted: src/iconStyle.scss modified: src/style.scss new file: src/tokens.scss modified: test/auro-icon.test.js

# [4.5.0-beta.1](v4.4.0...v4.5.0-beta.1) (2024-07-19) ### Features * update to support component theming ([c6fcdb3](c6fcdb3)), closes [#124](#124)

CLAassistant · 2024-08-20T17:11:46Z

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.
1 out of 2 committers have signed the CLA.

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

sourcery-ai · 2024-08-20T17:11:47Z

Reviewer's Guide by Sourcery

This pull request introduces significant updates to the auro-icon component, enhancing its functionality and customization options. The changes include support for custom SVG icons, new icon styles, improved theme support, and updated documentation. The primary focus is on implementing these new features while maintaining backwards compatibility and improving the overall flexibility of the component.

File-Level Changes

Files	Changes
`src/auro-icon.js` `demo/api.md` `apiExamples/customSvg.html`	Add support for custom SVG icons using the `customSvg` attribute
`src/auro-icon.js` `src/color.scss` `apiExamples/visualState.html` `apiExamples/onDark.html`	Introduce new icon styles including `info`, `secondary`, `subtle`, and `tertiary`
`src/auro-icon.js` `docs/api.md`	Deprecate the `primary` icon style
`src/tokens.scss` `src/color.scss`	Enhance theme support by allowing the component to be restyled using design tokens
`demo/api.md` `docs/api.md` `README.md`	Update documentation to reflect new features and changes
`src/auro-icon.js` `src/baseIcon.js`	Refactor component structure for better maintainability
`test/auro-icon.test.js`	Add tests for new features and functionality
`CHANGELOG.md` `package.json`	Update build and configuration files

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @jason-capsule42 - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding more unit tests to cover the new customSvg functionality and additional styling options.
Ensure clear documentation and migration guide for the deprecation of the 'primary' attribute.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟡 Testing: 5 issues found
🟢 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.}

src/auro-icon.js

test/auro-icon.test.js

demo/api.md

src/auro-icon.js

jason-capsule42 · 2024-08-20T17:29:23Z

@sourcery-ai review

sourcery-ai

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

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟡 Testing: 5 issues found
🟢 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.}

src/auro-icon.js

test/auro-icon.test.js

demo/api.md

blackfalcon · 2024-08-20T17:49:52Z

🎉 This PR is included in version 4.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

joelflachsbart · 2024-09-03T17:22:47Z

src/style.scss


  .logo {
    color: var(--ds-color-brand-midnight-400, $ds-color-brand-midnight-400);
  }
 }

+:host([customSize]) {
+  --auro-size-lg:100%


@jason-capsule42 Hey, it looks like the missing semi-colon got copied over to the new file. So #128 is still a problem

jason-capsule42 and others added 2 commits July 18, 2024 16:00

chore(release): 4.5.0-beta.1 [skip ci]

b6f4092

# [4.5.0-beta.1](v4.4.0...v4.5.0-beta.1) (2024-07-19) ### Features * update to support component theming ([c6fcdb3](c6fcdb3)), closes [#124](#124)

jason-capsule42 self-assigned this Aug 20, 2024

jason-capsule42 requested a review from a team as a code owner August 20, 2024 17:11

This was linked to issues Aug 20, 2024

auro-icon: customSvg #124

Closed

Update color tokens for theming support #112

Closed

sourcery-ai bot reviewed Aug 20, 2024

View reviewed changes

jason-capsule42 linked an issue Aug 20, 2024 that may be closed by this pull request

[issue summary] Missing semicolon in iconStyle.scss #128

Closed

sourcery-ai bot reviewed Aug 20, 2024

View reviewed changes

refactor: update code per Sourcery AI review

791ee6a

jason-capsule42 force-pushed the jbaker/betaRelease branch from 3b2c762 to 791ee6a Compare August 20, 2024 17:32

ci: change build script to include all asset builds

f6510bc

jason-capsule42 merged commit fb5b5bf into master Aug 20, 2024
5 of 6 checks passed

jason-capsule42 deleted the jbaker/betaRelease branch August 20, 2024 17:48

blackfalcon added the released Completed work has been released label Aug 20, 2024

jason-capsule42 changed the title ~~Jbaker/beta release~~ Release Beta to Main Aug 29, 2024

joelflachsbart reviewed Sep 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release Beta to Main #130

Release Beta to Main #130

jason-capsule42 commented Aug 20, 2024 •

edited by sourcery-ai bot

Loading

CLAassistant commented Aug 20, 2024

sourcery-ai bot commented Aug 20, 2024 •

edited

Loading

sourcery-ai bot left a comment

jason-capsule42 commented Aug 20, 2024

sourcery-ai bot left a comment

blackfalcon commented Aug 20, 2024

joelflachsbart Sep 3, 2024

Release Beta to Main #130

Release Beta to Main #130

Conversation

jason-capsule42 commented Aug 20, 2024 • edited by sourcery-ai bot Loading

Alaska Airlines Pull Request

Type of change:

Checklist:

Summary by Sourcery

CLAassistant commented Aug 20, 2024

sourcery-ai bot commented Aug 20, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

sourcery-ai bot left a comment

Choose a reason for hiding this comment

jason-capsule42 commented Aug 20, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

blackfalcon commented Aug 20, 2024

joelflachsbart Sep 3, 2024

Choose a reason for hiding this comment

jason-capsule42 commented Aug 20, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Aug 20, 2024 •

edited

Loading