-
Notifications
You must be signed in to change notification settings - Fork 285
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
ci(github): fix type exports in packages/cactus-verifier-client #3654
Conversation
Primary Changes --------------- 1. Removed packages/cactus-verifier-client/hyperledger-cactus-verifier- client-*.tgz in ignore paths in get-all-tgz-path.ts file 2. Removed the export of IVerifierEventListener and LedgerEvent from ./verifier and changed it to source from @hyperledger/cactus-core-api to resolve the type export issue encountered in this package Fixes: hyperledger-cacti#3633 Signed-off-by: ruzell22 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ruzell22 Unfortunately if we remove the VerifierEventListener, LedgerEvent,
types from the public API of the verifier-client package then that would be a breaking change and that can only happen when we release v3.0.0.
Before we continue the conversation, could you please double check if there are any other ways to fix the type exports that doesn't involve us not re-exporting the mentioned types from the core-api package?
It's not ideal but we must abide by the conventions to make sure people can safely upgrade minor versions such as from 2.0.0 to 2.0.1 or 2.1.0 when the time comes.
If you can't find any other workaround to make the type exports look good and also doesn't involve breaking changes then just respond back with a list of things/ideas/approaches that you have tried and I'll take a look at it as well. We can decide on how to proceed once we have more data about whether this is possible at all or not.
@petermetz here are different ways that I did in index.ts back then and now tried it to public-api.ts but it is still not fixing the type exports error. Test 1: Test 2: Test 3: Test 4: etc.... I ran I also tried tweaking the compilerOptions in tsconfig.json but did not do any changes. |
@ruzell22 OK, thank you for going the extra mile with the investigations. In that case unfortunately our only resort is to close this PR, temporarily until release v3.0.0 is due for issuance next Spring. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Temporarily closing, please see above for explanation. |
Commit to be reviewed
ci(github): fix type exports in packages/cactus-verifier-client
Fixes: #3633
Pull Request Requirements
upstream/main
branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.-s
flag when usinggit commit
command. You may refer to this link for more information.Character Limit
A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.