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: update version for js wrapper #165

Merged
merged 1 commit into from
Aug 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,13 @@ on:
required: true
default: false
type: boolean
publish-wrappers:
description: "Publish Wrappers to Registries"
publish-python-wrapper:
description: "Publish Python Wrapper to Registries"
required: true
default: false
type: boolean
publish-javascript-wrapper:
description: "Publish JavaScript Wrapper to Registries"
required: true
default: false
type: boolean
Expand Down Expand Up @@ -286,7 +291,7 @@ jobs:

- if: |
github.event_name == 'release' ||
(github.event_name == 'workflow_dispatch' && github.event.inputs.publish-wrappers == 'true')
(github.event_name == 'workflow_dispatch' && github.event.inputs.publish-python-wrapper == 'true')
name: Publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
Expand Down Expand Up @@ -341,7 +346,7 @@ jobs:
- name: Set NPM config
if: |
github.event_name == 'release' ||
(github.event_name == 'workflow_dispatch' && github.event.inputs.publish-wrappers == 'true')
(github.event_name == 'workflow_dispatch' && github.event.inputs.publish-javascript-wrapper == 'true')
run: |
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> .npmrc
echo "registry=https://registry.npmjs.org/" >> .npmrc
Expand All @@ -354,7 +359,7 @@ jobs:
- name: Publish
if: |
github.event_name == 'release' ||
(github.event_name == 'workflow_dispatch' && github.event.inputs.publish-wrappers == 'true')
(github.event_name == 'workflow_dispatch' && github.event.inputs.publish-javascript-wrapper == 'true')
run: npx lerna publish from-package --no-push --no-private --yes --no-git-tag-version

build-ios:
Expand Down
8 changes: 8 additions & 0 deletions wrappers/javascript/aries-askar-nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,11 @@ const key = Key.fromSeed({ algorithm: KeyAlgs.Bls12381G1, seed })
```

> **Note**: If you want to use this library in a cross-platform environment you need to import methods from the `@hyperledger/aries-askar-shared` package instead. This is a platform independent package that allows to register the native bindings. The `@hyperledger/aries-askar-nodejs` package uses this package under the hood. See the [Aries Askar Shared README](https://github.com/hyperledger/aries-askar/tree/main/wrappers/javascript/aries-askar-shared/README.md) for documentation on how to use this package.

## Version Compatibility

The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions:

| Aries Askar | JavaScript Wrapper |
| ----------- | ------------------ |
| v0.2.9 | v0.1.0, v0.1.1 |
4 changes: 2 additions & 2 deletions wrappers/javascript/aries-askar-nodejs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@hyperledger/aries-askar-nodejs",
"version": "0.1.0",
"version": "0.1.1",
"license": "Apache-2.0",
"description": "Nodejs wrapper for Aries Askar",
"source": "src/index",
Expand Down Expand Up @@ -47,7 +47,7 @@
"typescript": "4.5.5"
},
"dependencies": {
"@hyperledger/aries-askar-shared": "0.1.0",
"@hyperledger/aries-askar-shared": "0.1.1",
"@mapbox/node-pre-gyp": "^1.0.10",
"ffi-napi": "^4.0.3",
"node-cache": "^5.1.2",
Expand Down
8 changes: 8 additions & 0 deletions wrappers/javascript/aries-askar-react-native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,11 @@ const key = Key.fromSeed({ algorithm: KeyAlgs.Bls12381G1, seed })
```

> **Note**: If you want to use this library in a cross-platform environment you need to import methods from the `@hyperledger/aries-askar-shared` package instead. This is a platform independent package that allows to register the native bindings. The `@hyperledger/aries-askar-react-native` package uses this package under the hood. See the [Aries Askar Shared README](https://github.com/hyperledger/aries-askar/tree/main/wrappers/javascript/aries-askar-shared/README.md) for documentation on how to use this package.

## Version Compatibility

The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions:

| Aries Askar | JavaScript Wrapper |
| ----------- | ------------------ |
| v0.2.9 | v0.1.0, v0.1.1 |
4 changes: 2 additions & 2 deletions wrappers/javascript/aries-askar-react-native/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@hyperledger/aries-askar-react-native",
"version": "0.1.0",
"version": "0.1.1",
"license": "Apache-2.0",
"description": "React Native wrapper for Aries Askar",
"main": "build/index",
Expand Down Expand Up @@ -35,7 +35,7 @@
"install": "node-pre-gyp install"
},
"dependencies": {
"@hyperledger/aries-askar-shared": "0.1.0",
"@hyperledger/aries-askar-shared": "0.1.1",
"@mapbox/node-pre-gyp": "^1.0.10"
},
"devDependencies": {
Expand Down
8 changes: 7 additions & 1 deletion wrappers/javascript/aries-askar-shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,10 @@ try {

How you approach it is up to you, as long as the native binding are called before any actions are performed on the Aries Askar library.

---
## Version Compatibility

The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions:

| Aries Askar | JavaScript Wrapper |
| ----------- | ------------------ |
| v0.2.9 | v0.1.0, v0.1.1 |
2 changes: 1 addition & 1 deletion wrappers/javascript/aries-askar-shared/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@hyperledger/aries-askar-shared",
"version": "0.1.0",
"version": "0.1.1",
"license": "Apache-2.0",
"description": "Shared library for using Aries Askar with NodeJS and React Native",
"main": "build/index",
Expand Down
2 changes: 1 addition & 1 deletion wrappers/javascript/lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.1.0",
"version": "0.1.1",
"useWorkspaces": true,
"npmClient": "yarn",
"command": {
Expand Down