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

feat: 0.5 migration guide #166

Merged

Conversation

TimoGlastra
Copy link
Contributor

Migration guide for 0.5. Working on docs for openid4vc in separate PR.

@genaris I was wondering if you could make a PR after this PR is merged with the breaking changes to message pickup? You will have an easier time writing it I think :)

Signed-off-by: Timo Glastra <[email protected]>
Signed-off-by: Timo Glastra <[email protected]>
Signed-off-by: Timo Glastra <[email protected]>
@genaris
Copy link
Contributor

genaris commented Jun 4, 2024

Sure! In last meeting we found several outdated topics in the docs, mostly regarding mediation and pickup, and was going to write about them. Let's try to get this ready soon!

Copy link
Contributor

@berendsliedrecht berendsliedrecht left a comment

Choose a reason for hiding this comment

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

Nice work!!

await updateAssistant.update()
await updateAssistant.update({
// If you don't want to create a backup before the update process starts
// (see )
Copy link
Contributor

Choose a reason for hiding this comment

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

What does (see ) refer to?

guides/updating/update-indy-sdk-to-askar.md Show resolved Hide resolved

:::caution

The following APIs, modules and features are experimental and therefore not covered by the semver versioning in Credo. If you're using any of these features, make sure to use an exact version of Credo (`0.5.0`) instead of a range (`^0.5.0`):
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like we don't really push breaking changes on patch versions for experimental packages (or maybe we do it quite a bit). If that is the case, can we just keep them experimental (i.e. shit may break and use with caution), but just follow semver? Would make usage quite a bit nicer.

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 feel like we don't really push breaking changes on patch versions for experimental packages

I've pushed and released quite some breaking changes related to OpenId4VC in 0.5.x versions.

(i.e. shit may break and use with caution), but just follow semver?

I would really like this, but it means that ALL packages would get a major bump, and then it will become quite a mess. So if we want it, we need to start adopting a new version strategy where not all packages follow the same version. But this will get quite messy as well I think.

Or we should just start pushing out WAAY more versions. I've been thinking of adoptiong changesets: https://github.com/changesets/changesets I think this will really help with version management. But I still think we NEED to keep same version strategy as otherwise I'll become SOO complicated.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've pushed and released quite some breaking changes related to OpenId4VC in 0.5.x versions.

Yeah that will make it really difficult sadly.

I am not too familiar with changesets, but anything that will make our live easier with items like this is a yes for me!

@TimoGlastra TimoGlastra merged commit 8467ebf into openwallet-foundation:main Jun 4, 2024
1 check passed
@TimoGlastra
Copy link
Contributor Author

addressed feedback in #167

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