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

Update tags #53

Merged
merged 15 commits into from
Dec 24, 2024
Merged

Update tags #53

merged 15 commits into from
Dec 24, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 23, 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)

linking missing version tags

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

Update documentation, dependencies, tests, and configuration files. Update the contributing guidelines to clarify the process for submitting issues and pull requests. Update the code of conduct to remove specific contact information. Update the changelog to reflect the latest changes. Update the package version to 3.1.0.

Documentation:

  • Update documentation paths and content, including API examples and the README.

Tests:

  • Update test workflows to use Node.js versions 20 and 22.

Chores:

  • Update repository settings, labels, and stale bot configuration.

@rmenner rmenner requested a review from a team as a code owner December 23, 2024 21:31
Copy link

sourcery-ai bot commented Dec 23, 2024

Reviewer's Guide by Sourcery

This PR updates the documentation and configuration files to reflect changes in the project. It also updates dependencies to their latest versions.

Class diagram showing updated component registration

classDiagram
    class AuroSideNav {
        +register(name: string)
    }
    class AuroSideNavItem {
        +register(name: string)
    }
    class AuroSideNavSection {
        +register(name: string)
    }
    note for AuroSideNav "Changed from RuntimeUtils.registerComponent"
    note for AuroSideNavItem "Changed from RuntimeUtils.registerComponent"
    note for AuroSideNavSection "Changed from RuntimeUtils.registerComponent"
Loading

File-Level Changes

Change Details Files
Updated documentation to reflect changes in project and API usage.
  • Updated markdown partial pathing to consume new auro lib.
  • Updated documentation to reflect changes in project and API usage.
  • Updated repository settings and configurations.
  • Updated contribution guidelines.
  • Updated code of conduct.
  • Updated issue templates.
  • Updated workflow configurations.
  • Updated package dependencies.
  • Updated demo files.
  • Updated API examples.
  • Added exit criteria to issue templates.
  • Updated stale bot configuration.
  • Updated codeowners file.
  • Updated gitignore file.
  • Updated package-lock.json file.
  • Added new demo script file.
  • Updated accordion version.
  • Updated node version in CI workflow.
  • Updated semantic release configuration.
  • Updated surge configuration.
  • Updated codeql workflow configuration.
  • Updated test and publish workflow configuration.
  • Updated publish demo workflow configuration.
  • Updated labels in settings file.
  • Updated team permissions in settings file.
  • Updated branch protection rules in settings file.
  • Updated issue and pull request templates.
  • Updated documentation build process.
  • Updated API documentation.
  • Updated example code snippets.
  • Updated component version.
  • Updated dependency versions.
  • Updated node engine version.
  • Updated changelog.
  • Updated contributing guidelines.
  • Updated README file.
  • Updated demo index file.
  • Updated demo API file.
  • Updated partials for index and API documentation.
  • Updated API examples.
  • Updated custom element registration.
  • Updated recommended use and version control documentation.
  • Updated setup instructions.
  • Updated additional information section.
  • Updated use cases section.
  • Updated default example.
  • Updated responsive example.
  • Updated hyperlink example.
  • Updated selected example.
  • Updated sections example.
  • Updated isToggle example.
  • Updated custom example.
  • Updated heading example.
  • Updated token example.
  • Updated basic example.
  • Updated full example.
  • Updated pre-processed CSS example.
  • Updated JS example.
  • Updated HTML example.
  • Updated component import example.
  • Updated component registration example.
  • Updated custom component example.
  • Updated responsive sidenav example.
  • Updated sidenav item example.
  • Updated selected sidenav item example.
  • Updated sidenav section example.
  • Updated collapsible sidenav example.
  • Updated custom sidenav example.
  • Updated sidenav heading example.
  • Updated sidenav styling example.
  • Updated sidenav API examples.
  • Updated sidenav documentation.
  • Updated sidenav demo.
  • Updated sidenav package.
  • Updated sidenav version.
  • Updated sidenav dependencies.
  • Updated sidenav dev dependencies.
  • Updated sidenav peer dependencies.
  • Updated sidenav build process.
  • Updated sidenav test suite.
  • Updated sidenav documentation generation.
  • Updated sidenav demo deployment.
  • Updated sidenav release process.
  • Updated sidenav contribution guidelines.
  • Updated sidenav code of conduct.
  • Updated sidenav issue templates.
  • Updated sidenav pull request template.
  • Updated sidenav workflow configurations.
  • Updated sidenav stale bot configuration.
  • Updated sidenav codeowners file.
  • Updated sidenav gitignore file.
  • Updated sidenav package-lock.json file.
  • Added new sidenav demo script file.
  • Updated sidenav accordion version.
  • Updated sidenav node version in CI workflow.
  • Updated sidenav semantic release configuration.
  • Updated sidenav surge configuration.
  • Updated sidenav codeql workflow configuration.
  • Updated sidenav test and publish workflow configuration.
  • Updated sidenav publish demo workflow configuration.
  • Updated sidenav labels in settings file.
  • Updated sidenav team permissions in settings file.
  • Updated sidenav branch protection rules in settings file.
  • Updated sidenav issue and pull request templates.
  • Updated sidenav documentation build process.
  • Updated sidenav API documentation.
  • Updated sidenav example code snippets.
  • Updated sidenav component version.
  • Updated sidenav dependency versions.
  • Updated sidenav node engine version.
  • Updated sidenav changelog.
CHANGELOG.md
CONTRIBUTING.md
README.md
demo/api.md
demo/index.md
docs/partials/api.md
docs/partials/index.md
Updated dependencies to their latest versions.
  • Updated dependencies to their latest versions.
  • Updated package-lock.json file to reflect the latest dependency versions.
package.json
package-lock.json
Updated repository settings and configurations.
  • Updated repository settings and configurations.
  • Updated stale bot configuration.
  • Updated codeowners file.
  • Updated gitignore file.
.github/settings.yml
.github/stale.yml
.github/CODEOWNERS
.gitignore
Updated workflow configurations.
  • Updated workflow configurations.
  • Updated test and publish workflow configuration.
  • Updated publish demo workflow configuration.
  • Updated codeql workflow configuration.
.github/workflows/testPublish.yml
.github/workflows/publishDemo.yml
.github/workflows/codeql.yml
Updated issue and pull request templates.
  • Updated issue and pull request templates.
  • Added exit criteria to issue templates.
.github/PULL_REQUEST_TEMPLATE.md
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
Updated demo files and scripts.
  • Updated demo files and scripts.
  • Added new demo script file.
  • Updated accordion version.
demo/api.html
demo/api.js
demo/api.md
demo/index.html
demo/index.js
demo/index.md
rollup.config.mjs
src/accordionVersion.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.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

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

CLAassistant commented Dec 23, 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.
2 out of 3 committers have signed the CLA.

✅ sun-mota
✅ rmenner
❌ semantic-release-bot
You have signed the CLA already but the status is still pending? Let us recheck it.

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

Overall Comments:

  • Please provide more context in the PR description about the rationale for key changes, particularly the removal of accordionVersion.js and the addition of new Rollup configs.
Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@rmenner rmenner force-pushed the rmenner/update-tags-v2 branch from 7790552 to b621dea Compare December 23, 2024 21:36
Copy link

github-actions bot commented Dec 23, 2024

Surge demo deployment failed! 😭

Copy link
Contributor

@jordanjones243 jordanjones243 left a comment

Choose a reason for hiding this comment

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

Seems like the work that was done in this release has been undone: v3.0.1...v3.1.0

Is there a reason for this or was this an accident?

@rmenner rmenner linked an issue Dec 24, 2024 that may be closed by this pull request
@rmenner
Copy link
Contributor Author

rmenner commented Dec 24, 2024

Seems like the work that was done in this release has been undone: v3.0.1...v3.1.0

Is there a reason for this or was this an accident?

Nice catch. I will make sure those updates are transferred over.

sun-mota and others added 2 commits December 23, 2024 22:17
- Update dependency versions

- `AuroSideNav.register` is to easily register the element without extra importing
- `import "@aurodesignsystem/auro-sidenav"` will still register this element to <auro-sidenav>
- `import { AuroSideNav } from '../src/auro-sidenav` wont register this element until `AuroSideNav.register` gets called
- Same changes on `AuroSideNavItem` and `AuroSideNavSection`

- Fixed the typo on Recommended Use and Version Control: `clement` -> `element`
CHANGELOG.md Show resolved Hide resolved
@rmenner rmenner merged commit 55bc63b into main Dec 24, 2024
5 of 7 checks passed
@rmenner rmenner deleted the rmenner/update-tags-v2 branch December 24, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

auro-sidenav: semantic-release duplicate tag
5 participants