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

refactor!: drop UMD distribution from package #93

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jonkoops
Copy link
Contributor

BREAKING CHANGE: removes the UMD distribution from the package

What kind of change does this PR introduce?

  • Bug Fix
  • Feature
  • Refactoring
  • Style
  • Build
  • Chore
  • Documentation
  • CI

Did you add tests for your changes?

  • Yes, my code is well tested
  • Not relevant

If relevant, did you update the documentation?

  • Yes, I've updated the documentation
  • Not relevant

Summary
Removes the UMD distribution from the package in favor of using the module variant directly. This also removes the need to carry Rollup as a dependency. Documentation has also been cleaned up to reflect these changes.

Does this PR introduce a breaking change?
Yes, the UMD distrubution will no longer work, users should replace it with a direct import instead.

Other information
None.

BREAKING CHANGE: removes the UMD distribution from the package

Signed-off-by: Jon Koops <[email protected]>
@jonkoops
Copy link
Contributor Author

@rolandjitsu considering this is another breaking change this will likely trigger the semantic release bot to do a 2.0.0 release. Originally I was planning on doing all the breaking changes in a pre-1.0 version, and then doing a stable release, but now this is no longer possible we should probably disable the release pipeline or make it do 2.0 pre-releases for now.

@jonkoops
Copy link
Contributor Author

@jonkoops
Copy link
Contributor Author

Looks like setting up a beta branch would do this for us. @rolandjitsu could you create a beta branch? I'll change the PR to target it instead.

@coveralls
Copy link

Pull Request Test Coverage Report for Build f894d78de0dc288740cb6fa4085d2d51d422bd16-PR-93

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 7e3cef5c04289d0977f9d658f3ce71fec9b63616: 0.0%
Covered Lines: 89
Relevant Lines: 89

💛 - Coveralls

@rolandjitsu
Copy link
Collaborator

rolandjitsu commented Oct 11, 2024

Looks like setting up a beta branch would do this for us. @rolandjitsu could you create a beta branch? I'll change the PR to target it instead.

I can. We also need the right config in the workflows to allow running from beta and a releases config file.

This is an example of a release config that allows beta releases and maintenance branch releases:

plugins:
  - "@semantic-release/commit-analyzer"
  - "@semantic-release/release-notes-generator"
  - "@semantic-release/gitlab"
branches:
  - "master"
  - "+([0-9])?(.{+([0-9]),x}).x"
  - name: "beta"
    prerelease: "rc"

The above makes RC releases, but we can change to release as beta/alpha.

The release workflow also needs to change to something like:

on:
  push:
    branches:
      - master
      - "[0-9]+.[0-9]+.x"
      - beta

Copy link
Collaborator

@rolandjitsu rolandjitsu left a comment

Choose a reason for hiding this comment

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

LGTM

@jonkoops
Copy link
Contributor Author

Set up a pre-release workflow under #94, once that is merged we can set up the beta branch from it.

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.

3 participants