PEX icon indicating copy to clipboard operation
PEX copied to clipboard

Bug(sd-jwt): _sd_hash was renamed to sh_hash

Open cre8 opened this issue 1 year ago • 7 comments

  • I'm submitting a ... [x] bug report [ ] feature request [ ] question about the decisions made in the repository [ ] question about how to use this project

  • Summary After draft 6 the variable was renamed to sd_hash. A simple rename should be fine here: https://github.com/Sphereon-Opensource/PEX/blob/3432a23c4fc771f9ff8b9598bf7c77654903af66/lib/PEX.ts#L312

cre8 avatar Apr 22 '24 17:04 cre8

Should we include both for now? Removing it means it's not compatible anymore with current versions

TimoGlastra avatar Apr 22 '24 20:04 TimoGlastra

Mhh, when including both, there is no reason for people to update it. And since PEX has no semantic versioning, we can not announce it via a release...

cre8 avatar Apr 23 '24 07:04 cre8

We are using _sd_hash still and need some time to update -- i feel like deprecating _sd_hash, adding both and later removing _sd_hash feels like the smoothest path.

TimoGlastra avatar Apr 23 '24 07:04 TimoGlastra

And since PEX has no semantic versioning

I think PEX does have semantic versioning?

TimoGlastra avatar Apr 23 '24 07:04 TimoGlastra

And since PEX has no semantic versioning

I think PEX does have semantic versioning?

It has for the npm packages, but not on the releases here on github. But I am fine when we include both but decide on the next major release (v4) we drop support for the old approach. We just need to document it so we know when we remove it.

@TimoGlastra can we go this way?

cre8 avatar Apr 23 '24 08:04 cre8

Yeah we do use semver, also for the releases on GH. Having said that we typically do not maintain multiple major or minor versions at the same time. Thus all changes go into the latest releases.

For now suggest to go with both and indeed drop the old one in the next release

nklomp avatar Apr 23 '24 10:04 nklomp

Given the other PR will need a Major release, this is the chance to immediately move to the new name

nklomp avatar Apr 24 '24 21:04 nklomp