Make commit information opt-in #107
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: ea299ea The changes in this PR will be included in the next version bump. This PR includes changesets to release 27 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
!pr extract |
|
@jfer-siteimprove FYI. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we were automatically running
simple-gitto extract some commit information, and send it (with possible opt-out).This causes a major problem that
simple-gitrelies on running in a Node environment, thus simply trying to bundleSIP.ts(which greedily bundlessimple-git) for a browser environment with Webpack or the likes was causing the bundler to crash at build time.There was a minor inconvenience that the naming was tied to git, even if it represents nearly 90% of usage, that was a bit exclusive of other versioning systems.
With this PR, the commit information is optional and has to be provided by the caller. This should make
SIP.uploadusable in more environments. AgetCommitInformationhelper is still provided for git, but now has to be explicitly included by the user, thus not crashing the bundling in unexpected and hard-to-track ways.CommitInformation.GitOriginhas also been renamedCommitInformation.Originfor better compatibility.