-
Notifications
You must be signed in to change notification settings - Fork 3
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
SDK import by module #431
Closed
Closed
SDK import by module #431
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds the `--first-release` option to skip the tag generation. Adds documentation to why we're using each option. Adds an `npm install` step to properly update the package-lock.json
Delete packages from the SDK dist.
Blocked by lack of bandwidth at the moment. |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@wcalderipe please check that we are still exposing types from |
I'm going to close this PR; the branch exists if we decide to keep running w/ this, but this PR is getting pretty stale & not imminently going to be addressed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The SDK's main
index.ts
file was exporting everything, which led to frequent name clashing issues (e.g.,client
).This PR updates the SDK to have modules by path, such as
@narval-xyz/armory-sdk/vault
or@narval-xyz/armory-sdk/data-source
. It also fixes thepackages/release
target error because it was unable to derive the tag from git.Another important change was the proxy to
signature
andpolicy-engine-shared
packages. These are now also exported as modules.Interface comparison
From
To
Why manually move the files from
src
to the dist's root?For some reason, I couldn't make it work with the NX release build system when the
external
option is set tonone
. As a reminder, theexternal
option is crucial in the build process to bundle thesignature
andpolicy-engine-shared
into the SDK artifact.For more information about the
external
option, see #301.Why not a major version bump?
The SDK is in its early stages and the interface is also going to evolve quickly in the next month. I'd rather reserve the 1.0.0 for when we have a stable interface.