spectrum-web-components icon indicating copy to clipboard operation
spectrum-web-components copied to clipboard
verified publisher icon adobe

docs: deprecate jspm and use importMaps

Open Rajdeepc opened this issue 7 months ago • 3 comments

Description

This PR updates our documentation and code to address the deprecation of jspm.dev service. We're transitioning to recommend using import maps with ga.jspm.io, which provides superior caching of modules. The changes ensure Spectrum components at latest are properly supported via the JSPM generator with import maps.

Related issue(s)

  • https://github.com/jspm/jspm/issues/2595

Motivation and context

The jspm.dev service has been officially deprecated as detailed at https://jspm.org/jspm-dev-deprecation. This change is required to ensure our users have access to stable and maintained module loading infrastructure. The transition to import maps with ga.jspm.io provides better caching performance and long-term stability.

How has this been tested?

Testing included verifying that all Spectrum components at latest version load correctly using the new import maps approach with ga.jspm.io. Tests were conducted across multiple browsers and environments to ensure compatibility and performance.

  • [ ] Test case 1

    1. Go here
    2. Check the button is rendered properly with the bundle

  • [ ] Test case 2

    1. Go here
    2. Do this

  • [ ] Did it pass in Desktop?

  • [ ] Did it pass in Mobile?

  • [ ] Did it pass in iPad?

Screenshots (if appropriate)

Types of changes

  • [x] 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

  • [x] 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.

Rajdeepc avatar Apr 24 '25 17:04 Rajdeepc

⚠️ No Changeset found

Latest commit: f558012c14ce8dcc471a9cb27fa6f25e157e3332

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Apr 24 '25 17:04 changeset-bot[bot]

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file. If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

github-actions[bot] avatar Apr 24 '25 17:04 github-actions[bot]

Tachometer results

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

github-actions[bot] avatar Apr 24 '25 17:04 github-actions[bot]

deferred

Rajdeepc avatar Jun 28 '25 13:06 Rajdeepc

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5398

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file. If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

github-actions[bot] avatar Sep 17 '25 13:09 github-actions[bot]