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

chore: move gRPC client module root up #620

Merged
merged 4 commits into from
Jun 16, 2021
Merged

Conversation

zepatrik
Copy link
Member

@zepatrik zepatrik commented Jun 15, 2021

Related issue

closes #606

Proposed changes

Move go.mod and package.json up to the proto root. This way the whole path is included in the distributed package.
Also for the js client, there is now an index file in the version directory that accumulates all exports, and also an index file in the package root that points to the latest version.

Further comments

It would be nice to automate stuff around the index.js files.

TODO:

  • adjust release automation

@zepatrik zepatrik marked this pull request as ready for review June 15, 2021 14:59
@aeneasr
Copy link
Member

aeneasr commented Jun 15, 2021

Please document this as a breaking change in the git commit message. Best would be to show how to migrate from the old grpc module to the new one!

@zepatrik
Copy link
Member Author

So I put this as a commit message?


BREAKING: The npm package @ory/keto-grpc-client from now on includes all API versions. Because of that, the import paths changed. For migrating to the new client package, change the import path according to the following example:

- import acl from '@ory/keto-grpc-client/acl_pb.js'
+ // from the latest version
+ import { acl } from '@ory/keto-grpc-client'
+ // or a specific one
+ import acl from '@ory/keto-grpc-client/ory/keto/acl/v1alpha1/acl_pb.js'

@aeneasr
Copy link
Member

aeneasr commented Jun 16, 2021

Yup! :)

@zepatrik zepatrik merged commit 3b881f6 into master Jun 16, 2021
@zepatrik zepatrik deleted the fix/proto-package-root branch June 16, 2021 16:55
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.

Cannot use @ory/keto-grpc-client in js due to error
2 participants