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

feat: add 1.0.0 migration guide #4776

Merged
merged 5 commits into from
Oct 17, 2024

Conversation

rubencarvalho
Copy link
Collaborator

@rubencarvalho rubencarvalho commented Sep 19, 2024

Description

This PR introduces the migration guide for Spectrum Web Components version 1.0.0, which includes the removal of deprecated components and features. The migration guide outlines each removal and provides recommended steps for updating existing implementations.

Related issue(s)

Motivation and context

This change is required to inform users about the breaking changes in version 1.0.0 of Spectrum Web Components. By providing a detailed migration guide, we ensure consumers can smoothly upgrade their applications without disruption (or minimal disruption!).

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

@rubencarvalho rubencarvalho marked this pull request as ready for review September 19, 2024 17:27
@rubencarvalho rubencarvalho requested a review from a team as a code owner September 19, 2024 17:27
Copy link

github-actions bot commented Sep 19, 2024

Branch preview

Copy link

github-actions bot commented Sep 19, 2024

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.99 0.99
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
What is this?

Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 228.315 kB 217.536 kB 216.881 kB 🏆
Scripts 57.83 kB 52.668 kB 52.197 kB 🏆
Stylesheet 34.496 kB 30.396 kB 30.159 kB 🏆
Document 6.222 kB 5.484 kB 🏆 5.498 kB
Font 126.793 kB 126.64 kB 126.632 kB 🏆

Request Count

Category Latest Main Branch
Total 52 52 52
Scripts 41 41 41
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

Copy link

github-actions bot commented Sep 19, 2024

Tachometer results

Currently, no packages are changed by this PR...

@rubencarvalho rubencarvalho added 1.0.0 Issues that should be addressed for a 1.0 release! Documentation labels Oct 4, 2024
Copy link
Collaborator

@najikahalsema najikahalsema left a comment

Choose a reason for hiding this comment

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

Looks good overall! Just added some newlines, mainly + a couple questions that aren't blocking.

Copy link
Collaborator

@najikahalsema najikahalsema left a comment

Choose a reason for hiding this comment

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

lgtm! thanks

@rubencarvalho rubencarvalho merged commit 3f6b8c8 into ruben/remove-deprecations Oct 17, 2024
53 of 57 checks passed
@rubencarvalho rubencarvalho deleted the ruben/1-0-0-migration-guide branch October 17, 2024 21:34
rubencarvalho added a commit that referenced this pull request Oct 29, 2024
* chore: remove 'variant' and 'static' attributes from coach-indicator (#4772)

* chore: remove split-button component (#4729)

* chore: remove banner component (#4723)

* chore: remove deprecated badge  values (#4742)

* chore: remove sp-quick-actions (#4761)

* chore: remove popover's dialog property (#4751)

* chore: remove thumbnail deprecated sizes (#4760)

* chore: remove progress-circle overBackground property (#4750)

* chore: remove deprecated 'static' references (#4818)

* chore: remove action-button variant property (#4741)

* chore: remove 'theme' attribute from sp-theme (#4765)

* feat: add 1.0.0 migration guide (#4776)
rubencarvalho pushed a commit that referenced this pull request Oct 30, 2024
…4829)

- feat(styles): add Spectrum 2 styles
- feat(icons-workflow): add support for new Spectrum 2 icons (#4747)
- feat(icon): add support for Spectrum 2 icons (#4747)
- chore: remove pre-1.0.0 deprecations (#4828)
- feat(coach-indicator)!: remove 'variant' and 'static' attributes from coach-indicator (#4772)
- feat(split-button)!: remove split-button component (#4729)
- feat(banner)!: remove banner component (#4723)
- feat(badge)!: remove deprecated badge values (#4742)
- feat(quick-actions)!: remove sp-quick-actions (#4761)
- feat(popover)!: remove popover's dialog property (#4751)
- feat(thumbnail)!: remove thumbnail deprecated sizes (#4760)
- feat(progress-circle)!: remove progress-circle overBackground property (#4750)
- feat(action-button,action-group,action-menu,button,link,meter,progress-bar): remove deprecated 'static' references (#4818)
- feat(action-button)!: remove action-button variant property (#4741)
- feat(theme)!: remove 'theme' attribute from sp-theme (#4765)
- chore: make the spectrum-two theme fully functional (#4859)
- chore: add 1.0.0 migration guide (#4776)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0 Issues that should be addressed for a 1.0 release! Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants