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

breaking: conversion to v2 addon format #390

Merged
merged 2 commits into from
Jan 22, 2025
Merged

Conversation

aklkv
Copy link
Contributor

@aklkv aklkv commented Dec 24, 2024

If merged, this PR converts this addon to the V2 addon format. Resolves #359, #372, and #380.

Details

  • moved dummy app into test-app
  • converted the navigation-narrator component to gts
  • moved the addon to the addon/src folder
  • removed outdated/no longer used automation config files
  • updated ember-try scenarios

Breaking Changes

  • CSS has to be imported manually
  • Dropped support for Ember versions earlier than v4.12
  • Dropped support for Node versions earlier than v18

@aklkv aklkv force-pushed the feat/v2 branch 11 times, most recently from f88c180 to d361b82 Compare December 31, 2024 10:34
@aklkv aklkv force-pushed the feat/v2 branch 3 times, most recently from 7b281d4 to 1ff4104 Compare January 7, 2025 22:46
@aklkv aklkv marked this pull request as ready for review January 7, 2025 23:02
@aklkv
Copy link
Contributor Author

aklkv commented Jan 7, 2025

@MelSumner I think this is ready to go, and hopefully CI passes, I have tested everything locally

@aklkv aklkv force-pushed the feat/v2 branch 2 times, most recently from a8b7be9 to b2d48a0 Compare January 8, 2025 00:35
@MelSumner
Copy link
Member

@MelSumner I think this is ready to go, and hopefully CI passes, I have tested everything locally

I'll do my best to review this ASAP, can you make sure to update the PR description with the changes made?

test-app/README.md Outdated Show resolved Hide resolved
@aklkv aklkv mentioned this pull request Jan 10, 2025
@josephdsumner
Copy link
Contributor

This should close a number if open issues. Once this is merged we can look into adding relase-plan.

Breaking changes:

  • if consumer need css, it has to be now imported manually

@aklkv

Question: Do we need to do something similar in order for the stylelint floating-deps check to work properly?

@MelSumner MelSumner changed the title feat: v2 addon format breaking: conversion to v2 addon format Jan 17, 2025
Copy link
Member

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

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

Three things:

  1. Please review the test that is failing
  2. Check the updated description, I gave it a go but there may be more we wish to include.
  3. Please add instructions to the README for how users need to import the CSS for the addon; I think that would be appropriate for this PR, since that changed in this PR.

Anything else that was a nice-to-have has been moved to separate issues.

Thank you so much! Can't wait to get this out as a new release!

Copy link
Contributor

@josephdsumner josephdsumner left a comment

Choose a reason for hiding this comment

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

Approving this PR with the expectation that the sole outstanding floating-dependencies issue will be resolved before merge + release. It looks great -- both my and and @MelSumner 's change requests have either been made or appropriately scoped elsewhere to my satisfaction.

👍

@aklkv aklkv force-pushed the feat/v2 branch 3 times, most recently from 41d4f09 to 045e390 Compare January 18, 2025 12:58
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 thanks for looking into this -- I have approved the CI run.

Copy link
Contributor

Choose a reason for hiding this comment

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

No luck -- I'll take a closer look at this against the latest v2 addon blueprint for stylelint deps / versions / config.

Copy link
Contributor Author

@aklkv aklkv Jan 19, 2025

Choose a reason for hiding this comment

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

I have a idea that it might be relate to pnpm v10 and --no-lockfile and verify-deps-before-run options, it might have been removed

Copy link
Contributor Author

@aklkv aklkv Jan 19, 2025

Choose a reason for hiding this comment

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

yep, here we go pnpm/pnpm#8865
it seems solution is in main but not release, I would say we can either skip this part of CI so we can merge this PR and them unskip when pnpm releases a new version which should not take too long, or just wait till release and then merge this PR. Optionally disable verify-deps-before-run flag for now

Copy link
Contributor

Choose a reason for hiding this comment

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

Happy to see the fix has been identified and merged upstream. I'd hope for a quick turnaround for a release with our blocker fixed in there. Pnpm shipping a larger, slower release with a wave of fixes for the new major would be understandable.

Question: what do you think about filing this issue as a blocker for cutting our next release, but not letting it block this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah it's not blocking at all, just nice to have. I have commented out this flag for now, since CI is green I think we are gtg, I will add some readme update in a bit + create follow up PR for uncommenting pnpm flag

Copy link
Contributor

Choose a reason for hiding this comment

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

Question: is there any reason we can't keep pnpm@9 and ship both the PR and release immediately?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you can ship immediately on pnpm@v10, without follow up PR as it's not really important for end consumer

Copy link
Member

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

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

Ok, I think this is good for now, we'll follow up with a few more PRs before cutting a release. Thank you for your contributions!!

@josephdsumner josephdsumner merged commit 40df81d into ember-a11y:main Jan 22, 2025
9 checks passed
@aklkv aklkv deleted the feat/v2 branch January 22, 2025 23:10
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.

Update to npm-run-all2 causing issues Upgrade to current release Convert to V2 addon
3 participants