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] Version 2.0 #16

Merged
merged 12 commits into from
Sep 20, 2023
Merged

[Breaking] Version 2.0 #16

merged 12 commits into from
Sep 20, 2023

Conversation

benogle
Copy link
Contributor

@benogle benogle commented Sep 20, 2023

This is a breaking change for both AnvilEmbedFrame and AnviSignatureModal, see the respective readmes for upgrade instructions:

This PR upgrades all dependencies in all AnvilEmbedFrame and AnvilSignatureModal plus

  • AnvilSignatureModal
    • Upgrades to use AnvilEmbedFrame
  • AnvilEmbedFrame
    • Removes enableDefaultStyles
    • Removes title attribute
  • Updates all docs
  • Adds an upgrading section to the readmes

Changes will result in a major version bump (v2) for both components

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

@benogle benogle self-assigned this Sep 20, 2023
@@ -1,6 +1,6 @@
{
"name": "@anvilco/anvil-embed-frame",
"version": "1.1.0",
"version": "2.0.0-alpha.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

good to move off the alpha version?

Choose a reason for hiding this comment

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

probably waiting for lerna publish to handle it after merging?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will publish both repos after merge!


* `signURL` -> `iframeURL`
* `onFinishSigning` -> `onEvent`. Check the `eventObject.action === 'signerComplete'` to detect a signer has finished signing
* `onError` -> `onEvent`. Check the `eventObject.action` to determine if there is an error
Copy link
Contributor

Choose a reason for hiding this comment

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

should be eventObject.error

@@ -1,6 +1,6 @@
{
"name": "@anvilco/react-signature-modal",
"version": "1.8.4",
"version": "2.0.1-alpha.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

same here, alpha is ok?

@fostimus
Copy link
Contributor

Just the few small things in comments

@benogle benogle merged commit 26fb2eb into main Sep 20, 2023
3 checks passed
@benogle benogle changed the title [Breaking] Update dependencies [Breaking] Version 2.0 Sep 20, 2023
@benogle benogle deleted the bo/update branch September 20, 2023 22:07
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.

None yet

3 participants