Skip to content

Versioning and breaking changes #166

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

Open
arnemolland opened this issue Apr 24, 2025 · 1 comment · Fixed by #167
Open

Versioning and breaking changes #166

arnemolland opened this issue Apr 24, 2025 · 1 comment · Fixed by #167
Assignees

Comments

@arnemolland
Copy link
Contributor

Hey, I just wanted to notify you that some of the recent minor version changes included non-backwards compatible, breaking changes (#159). In my case it was the sudden requirement of non-padded base64url strings for some of the request/authenticate options -- nowhere in the source code or any docs could I find any information on what the required formats were either, other than the type itself which is String regardless, until I found the introduced validator.

I just want to urge you to follow semantic versioning, especially when introducing breaking changes like this. I'll see if I can help with documenting these requirements too.

@Dopeamin
Copy link
Collaborator

@arnemolland Thank you for adding the dartdocs that is very helpful i will be taking a look at it asap. Concerning the breaking change you mentioned. Can you specify in which cases it is broken :

  • Which platform ?
  • Which flow
  • Which attribute is causing it ? (with the old value so i can test myself)

I didn't consider the change as a breaking change as from my testing if those values were not of the mentioned new type the authenticator wouldn't work correctly . So if the flow worked fine before the change theoretically it should work fine also after it. So if you could share more information it would be quite helpful .

@Dopeamin Dopeamin reopened this Apr 24, 2025
@Dopeamin Dopeamin self-assigned this Apr 25, 2025
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 a pull request may close this issue.

2 participants