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 #131

Merged
merged 18 commits into from
Oct 4, 2024
Merged

Jbaker/beta release #131

merged 18 commits into from
Oct 4, 2024

Conversation

jason-capsule42
Copy link
Member

@jason-capsule42 jason-capsule42 commented Oct 4, 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

Release a beta version of the auro-flight component with theme support, refactor CSS for better maintainability, and update documentation and tests to reflect these changes.

New Features:

  • Introduce theme support for the auro-flight component, allowing customization through design tokens.

Enhancements:

  • Refactor CSS to use shared styles and extendable placeholders for consistent styling across components.
  • Update the auro-flight component to use a dynamic tag for the auro-datetime element, improving flexibility and maintainability.

Documentation:

  • Add documentation for new attributes and theme support in the auro-flight component.

Tests:

  • Update tests for the auro-flight-main component to reflect changes in the auro-datetime element usage.

Chores:

  • Remove unused scripts and update ESLint configuration for better code quality management.

jordanjones243 and others added 17 commits October 4, 2024 11:20
* implement tier 3 token structure [#121](#121) ([874e9ce](874e9ce))

* update deps and refactor scripts to use auro-library versions ([238a929](238a929))
* **#123:** rerouted departure and arrival stations display as expected now ([5201a33](5201a33)), closes [#123](#123)
* implement tier 3 token structure [#121](#121) ([874e9ce](874e9ce))

* update deps and refactor scripts to use auro-library versions ([238a929](238a929))
Somehow, this repo was missing a lot of the new build scripts, and was not able to generate a new README or other docs.

This commit adds those sans the `build:version` script as we did not need that for this repo.

Changes to be committed:
	modified:   demo/api.html
	modified:   package.json
# [2.8.0-beta.2](v2.8.0-beta.1...v2.8.0-beta.2) (2024-08-19)

### Bug Fixes

* **#123:** rerouted departure and arrival stations display as expected now ([73eb66c](73eb66c)), closes [#123](#123)

### Performance Improvements

* update deps and refactor scripts to use auro-library versions ([52683c2](52683c2))
BREAKING CHANGE: trigger major release for color theme support #121
# [3.0.0-beta.1](v2.8.0-beta.2...v3.0.0-beta.1) (2024-10-03)

### Features

* add custom registered auro-datetime ([33a189b](33a189b))
* add tag name as attribute when custom registered ([26808eb](26808eb))

### Performance Improvements

* refactor custom component registration config ([1f3e0de](1f3e0de))
* remove github label colors ([b5187c0](b5187c0))
* update dependencies ([2de3a30](2de3a30))

### BREAKING CHANGES

* trigger major release for color theme support #121
@jason-capsule42 jason-capsule42 requested a review from a team as a code owner October 4, 2024 18:53
@CLAassistant
Copy link

CLAassistant commented Oct 4, 2024

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

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

Copy link

sourcery-ai bot commented Oct 4, 2024

Reviewer's Guide by Sourcery

This pull request implements several changes to the auro-flight component, including code refactoring, styling updates, and dependency management improvements. The changes aim to enhance the component's maintainability, performance, and adherence to design standards.

Class diagram for AuroFlight and AuroFlightMain components

classDiagram
    class AuroFlight {
        +AuroLibraryRuntimeUtils runtimeUtils
        +firstUpdated()
        +static get properties()
        +static get styles()
    }
    class AuroFlightMain {
        +AuroDependencyVersioning versioning
        +String datetimeTag
        +static get styles()
        +constructor()
    }
    AuroFlightMain --> AuroFlight : uses
    AuroFlightMain --> AuroDependencyVersioning
    AuroFlight --> AuroLibraryRuntimeUtils
Loading

File-Level Changes

Change Details Files
Refactored styling approach to improve maintainability and theming support
  • Separated color styles into new files (color-flight.scss, color-flight-header.scss, color-flight-main.scss)
  • Introduced tokens.scss file for centralized management of design tokens
  • Updated existing style files to remove direct color definitions
  • Modified component files to import and use the new style structure
src/style-flight-main.scss
src/style-flight-header.scss
src/style-flight.scss
src/color-flight-main.scss
src/color-flight-header.scss
src/color-flight.scss
src/tokens.scss
src/auro-flight-main.js
src/auro-flight-header.js
src/auro-flight.js
Updated dependency management and component registration
  • Introduced versioning for auro-datetime component
  • Updated component registration process in index.js
  • Modified eslint configuration
  • Updated README.md with new installation and usage instructions
src/auro-flight-main.js
src/datetimeVersion.js
index.js
eslint.config.mjs
README.md
Improved accessibility and internationalization support
  • Added 'da' attribute for ISO 8601 time of arrival
  • Updated API documentation to reflect new attributes and properties
src/auro-flight-main.js
docs/api.md
demo/api.md
Removed unnecessary files and updated build process
  • Deleted scripts/generateDocs.mjs, scripts/postCss.mjs, scripts/prepForBuild.js, and scripts/staticStyles-template.js
  • Updated demo and test files to reflect changes in component structure
demo/index.html
demo/api.html
test/auro-flight-main.test.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.
  • 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

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 found some issues that need to be addressed.

Blocking issues:

  • Hard-coded version number found. (link)

Overall Comments:

  • The refactoring and modularization of styles improve maintainability, but ensure that documentation generation is still handled appropriately after removing scripts like generateDocs.mjs.
  • Consider adding comments explaining the purpose of new files like datetimeVersion.js and the rationale behind splitting color styles into separate files.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🔴 Security: 1 blocking issue
  • 🟡 Testing: 2 issues found
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 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.

src/auro-flight-main.js Outdated Show resolved Hide resolved
test/auro-flight-main.test.js Show resolved Hide resolved
test/auro-flight-main.test.js Show resolved Hide resolved
demo/api.md Outdated Show resolved Hide resolved
demo/api.md Outdated Show resolved Hide resolved
src/datetimeVersion.js Show resolved Hide resolved
@jason-capsule42 jason-capsule42 linked an issue Oct 4, 2024 that may be closed by this pull request
2 tasks
@jason-capsule42 jason-capsule42 self-assigned this Oct 4, 2024
@jason-capsule42 jason-capsule42 merged commit 3a2fe74 into main Oct 4, 2024
5 of 6 checks passed
@jason-capsule42 jason-capsule42 deleted the jbaker/betaRelease branch October 4, 2024 19:05
@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
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
6 participants