Skip to content

Commit

Permalink
Merge branch 'main' into chore/update-ci
Browse files Browse the repository at this point in the history
  • Loading branch information
TimoGlastra authored Jan 30, 2024
2 parents a53f028 + 16ae11e commit d485418
Show file tree
Hide file tree
Showing 35 changed files with 147 additions and 140 deletions.
2 changes: 1 addition & 1 deletion .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

repository:
name: credo-ts-ext
description: Extension libraries for Aries Framework JavaScript
description: Extension libraries for Credo
homepage: https://github.com/openwallet-foundation/credo-ts-ext
default_branch: main
has_downloads: false
Expand Down
4 changes: 2 additions & 2 deletions .github/templates/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Provide a general summary of your changes in the Title above

<!--- If it relates to an open issue, please link to the issue here.
e.g.
[#123](https://github.com/hyperledger/aries-framework-javascript-ext/issues/123)
[#123](https://github.com/openwallet-foundation/credo-ts-ext/issues/123)
-->

[#](https://github.com/hyperledger/aries-framework-javascript-ext/issues/)
[#](https://github.com/openwallet-foundation/credo-ts-ext/issues/)

## Does this PR introduce a breaking change?

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/continuous-deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- rest-v*

env:
IMAGE_NAME: ghcr.io/hyperledger/afj-rest
IMAGE_NAME: ghcr.io/openwallet-foundation/credo-rest

jobs:
release-rest-docker-image:
Expand All @@ -31,7 +31,7 @@ jobs:
run: yarn install --frozen-lockfile

- name: Build rest package
run: yarn workspace @aries-framework/rest build
run: yarn workspace @credo-ts/rest build

- name: Extract metadata (tags, labels) for Docker
id: meta
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ name: Continuous Integration

on:
pull_request:
branches: [main, 'afj-**']
branches: [main, 'credo-**']
types: [opened, synchronize, reopened, labeled]
push:
branches: [main, 'afj-**']
branches: [main, 'credo-**']

env:
TEST_AGENT_PUBLIC_DID_SEED: 000000000000000000000000Trustee9
Expand Down Expand Up @@ -119,7 +119,7 @@ jobs:

package-finder:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main' && github.repository == 'hyperledger/aries-framework-javascript-ext' && github.event_name == 'push'
if: github.ref == 'refs/heads/main' && github.repository == 'openwallet-foundation/credo-ts-ext' && github.event_name == 'push'
needs: [integration-test, validate]
outputs:
packages: ${{ steps.get-packages.outputs.packages }}
Expand Down
4 changes: 2 additions & 2 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-License-Identifier: Apache-2.0

# Aries Framework Javascript maintainers
* @hyperledger/aries-framework-javascript-committers
# Credo maintainers
* @openwallet-foundation/credo-ts-committers
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Some general notes on creating a new package:

Releases are managed using [Release Please](https://github.com/googleapis/release-please). It will automatically scan all commits using conventional commits standard. If changes are detected that will trigger a version bump using either the `feat:` or `fix:` scope, or `!` (e.g. `feat!:`) for breaking changes, release please will open a PR with the version bump and updates to `CHANGELOG.md`. The PR will be automatically kept up to date, and once it will be merged a new release will be created on Github and the package will be released on NPM.

See [this PR](https://github.com/hyperledger/aries-framework-javascript-ext/pull/32) for an example. Each package is versioned independently, to let packages evolve at their own pace. To make the release process as smooth as possible, make sure you're following these guidelines:
See [this PR](https://github.com/openwallet-foundation/credo-ts-ext/pull/32) for an example. Each package is versioned independently, to let packages evolve at their own pace. To make the release process as smooth as possible, make sure you're following these guidelines:

- Make sure your commits follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.
- If you want to squash your PR only the title of the PR should be following conventional commits.
Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Maintainers

See [MAINTAINERS.md](https://github.com/hyperledger/aries-framework-javascript/blob/main/MAINTAINERS.md) in the Aries Framework JavaScript repository.
See [MAINTAINERS.md](https://github.com/openwallet-foundation/credo-ts/blob/main/MAINTAINERS.md) in the Credo repository.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@
<br />
<img
alt="Hyperledger Aries logo"
src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
src="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
height="250px"
/>
</p>
<h1 align="center"><b>Aries Framework JavaScript Extensions</b></h1>
<h1 align="center"><b>Credo Extensions</b></h1>
<p align="center">
<img
alt="Pipeline Status"
src="https://github.com/hyperledger/aries-framework-javascript-ext/workflows/Continuous%20Integration/badge.svg?branch=main"
src="https://github.com/openwallet-foundation/credo-ts-ext/workflows/Continuous%20Integration/badge.svg?branch=main"
/>
<a
href="https://lgtm.com/projects/g/hyperledger/aries-framework-javascript-ext/context:javascript"
href="https://lgtm.com/projects/g/openwallet-foundation/credo-ts-ext/context:javascript"
><img
alt="Language grade: JavaScript"
src="https://img.shields.io/lgtm/grade/javascript/g/hyperledger/aries-framework-javascript-ext.svg?logo=lgtm&logoWidth=18"
src="https://img.shields.io/lgtm/grade/javascript/g/openwallet-foundation/credo-ts-ext.svg?logo=lgtm&logoWidth=18"
/></a>
<a href="https://codecov.io/gh/hyperledger/aries-framework-javascript-ext/"
<a href="https://codecov.io/gh/openwallet-foundation/credo-ts-ext/"
><img
alt="Codecov Coverage"
src="https://img.shields.io/codecov/c/github/hyperledger/aries-framework-javascript-ext/coverage.svg?style=flat-square"
src="https://img.shields.io/codecov/c/github/openwallet-foundation/credo-ts-ext/coverage.svg?style=flat-square"
/></a>
<a
href="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript-ext/main/LICENSE"
href="https://raw.githubusercontent.com/openwallet-foundation/credo-ts-ext/main/LICENSE"
><img
alt="License"
src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
Expand All @@ -43,30 +43,30 @@
<a href="#license">License</a>
</p>

Aries Framework JavaScript Extensions is an extension repo to [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript.git) (AFJ). It hosts libraries built on top of Aries Framework JavaScript that don't necessarily belong to the core of the project. Example extension libraries include React Hooks for AFJ and a REST API wrapper.
Credo Extensions is an extension repo to [Credo](https://github.com/openwallet-foundation/credo-ts.git). It hosts libraries built on top of Credo that don't necessarily belong to the core of the project. Example extension libraries include React Hooks for Credo and a REST API wrapper.

If you're just getting started the [AFJ repo](https://github.com/hyperledger/aries-framework-javascript.git) is probably the place to start.
If you're just getting started the [Credo repo](https://github.com/openwallet-foundation/credo-ts.git) is probably the place to start.

## Packages

All packages are placed in the [`packages/`](./packages) directory.

| Package | Version | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [`@aries-framework/rest`](https://www.npmjs.com/package/@aries-framework/rest) | ![@aries-framework/rest version](https://img.shields.io/npm/v/@aries-framework/rest) | REST endpoint wrapper for using your agent over HTTP |
| [`@aries-framework/react-hooks`](https://www.npmjs.com/package/@aries-framework/react-hooks) | ![@aries-framework/react-hooks version](https://img.shields.io/npm/v/@aries-framework/react-hooks) | React Hooks for data handling and agent interaction |
| [`@aries-framework/redux-store`](https://www.npmjs.com/package/@aries-framework/redux-store) | ![@aries-framework/redux-store version](https://img.shields.io/npm/v/@aries-framework/redux-store) | Redux Toolkit wrapper around Aries Framework JavaScript |
| [`@aries-framework/push-notifications`](https://www.npmjs.com/package/@aries-framework/push-notifications) | ![@aries-framework/push-notifications version](https://img.shields.io/npm/v/@aries-framework/push-notifications) | Push notification plugin for Aries Framework JavaScript |
| [`@aries-framework/transport-ble`](https://www.npmjs.com/package/@aries-framework/transport-ble) | ![@aries-framework/transport-ble version](https://img.shields.io/npm/v/@aries-framework/transport-ble) | Bluetooth Low Energy transport for Aries Framework JavaScript |
| Package | Version | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| [`@credo-ts/rest`](https://www.npmjs.com/package/@credo-ts/rest) | ![@credo-ts/rest version](https://img.shields.io/npm/v/@credo-ts/rest) | REST endpoint wrapper for using your agent over HTTP |
| [`@credo-ts/react-hooks`](https://www.npmjs.com/package/@credo-ts/react-hooks) | ![@credo-ts/react-hooks version](https://img.shields.io/npm/v/@credo-ts/react-hooks) | React Hooks for data handling and agent interaction |
| [`@credo-ts/redux-store`](https://www.npmjs.com/package/@credo-ts/redux-store) | ![@credo-ts/redux-store version](https://img.shields.io/npm/v/@credo-ts/redux-store) | Redux Toolkit wrapper around Credo |
| [`@credo-ts/push-notifications`](https://www.npmjs.com/package/@credo-ts/push-notifications) | ![@credo-ts/push-notifications version](https://img.shields.io/npm/v/@credo-ts/push-notifications) | Push notification plugin for Credo |
| [`@credo-ts/transport-ble`](https://www.npmjs.com/package/@credo-ts/transport-ble) | ![@credo-ts/transport-ble version](https://img.shields.io/npm/v/@credo-ts/transport-ble) | Bluetooth Low Energy transport for Credo |

## Contributing

If you would like to contribute to this repository, please read the [CONTRIBUTING](/CONTRIBUTING.md) guidelines. These documents will provide more information to get you started!

For running tests, make sure to follow the network setup guides from the Aries Framework JavaScript [DEVREADME.md](https://github.com/hyperledger/aries-framework-javascript/blob/main/DEVREADME.md).
For running tests, make sure to follow the network setup guides from the Credo [DEVREADME.md](https://github.com/openwallet-foundation/credo-ts/blob/main/DEVREADME.md).

The Aries Framework JavaScript call takes place every week at Thursday, 14:00 UTC via [Zoom](https://zoom.us/j/99751084865?pwd=TW1rU0FDVTBqUlhnWnY2NERkd1diZz09). This meeting is for contributors to groom and plan the backlog, and discuss issues. Feel free to join!
There are regular community working groups to discuss ongoing efforts within Credo, showcase items you've built with Credo, or ask questions. See [Meeting Information](https://github.com/openwallet-foundation/credo-ts/wiki/Meeting-Information) for up to date information on the meeting schedule. Everyone is welcome to join!

## License

Hyperledger Aries Framework JavaScript is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).
Credo is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).
4 changes: 2 additions & 2 deletions network/add-did-from-seed.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ export SEED=${1?"Seed missing\nUsage: $0 SEED ROLE"}
export ROLE=$2

echo "
wallet open afj-wallet key=password
wallet open credo-wallet key=password
pool connect afj-pool
pool connect credo-pool
did new seed=${SEED}" >/etc/indy/command.txt

Expand Down
4 changes: 2 additions & 2 deletions network/add-did.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ if [ -z "$ROLE" ]; then
fi

echo "
wallet open afj-wallet key=password
pool connect afj-pool
wallet open credo-wallet key=password
pool connect credo-pool
did use V4SGRU86Z58d6TV7PBUe6f
ledger nym did=${DID} verkey=${VERKEY} role=${ROLE}" >/etc/indy/command.txt
Expand Down
8 changes: 4 additions & 4 deletions network/indy-cli-setup.sh
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#!/bin/bash

echo '
wallet create afj-wallet key=password
wallet open afj-wallet key=password
wallet create credo-wallet key=password
wallet open credo-wallet key=password
pool create afj-pool gen_txn_file=/etc/indy/genesis.txn
pool connect afj-pool
pool create credo-pool gen_txn_file=/etc/indy/genesis.txn
pool connect credo-pool
did new seed=000000000000000000000000Trustee1
did use V4SGRU86Z58d6TV7PBUe6f
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "aries-framework-ext",
"name": "credo-ext",
"private": true,
"license": "Apache-2.0",
"description": "Monorepo containing extensions for Aries Framework JavaScript",
"description": "Monorepo containing extensions for Credo",
"workspaces": {
"packages": [
"packages/*"
],
"nohoist": [
"@aries-framework/*",
"**/@aries-framework/*",
"**/@aries-framework/*/**",
"@aries-framework/*/**",
"@credo-ts/*",
"**/@credo-ts/*",
"**/@credo-ts/*/**",
"@credo-ts/*/**",
"@hyperledger/*",
"**/@hyperledger/*",
"**/@hyperledger/*/**",
Expand Down Expand Up @@ -39,7 +39,7 @@
]
},
"repository": {
"url": "https://github.com/hyperledger/aries-framework-javascript-ext",
"url": "https://github.com/openwallet-foundation/credo-ts-ext",
"type": "git"
},
"scripts": {
Expand Down
14 changes: 7 additions & 7 deletions packages/push-notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
<br />
<img
alt="Hyperledger Aries logo"
src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
src="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
height="250px"
/>
</p>
<h1 align="center"><b>Aries Framework JavaScript Push Notifications Plugin</b></h1>
<h1 align="center"><b>Credo Push Notifications Plugin</b></h1>
<p align="center">
<a
href="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript-ext/main/LICENSE"
href="https://raw.githubusercontent.com/openwallet-foundation/credo-ts-ext/main/LICENSE"
><img
alt="License"
src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
Expand All @@ -19,15 +19,15 @@
alt="typescript"
src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg"
/></a>
<a href="https://www.npmjs.com/package/@aries-framework/push-notifications"
<a href="https://www.npmjs.com/package/@credo-ts/push-notifications"
><img
alt="@aries-framework/push-notifications version"
src="https://img.shield.io/npm/v/@aries-framework/push-notifications"
alt="@credo-ts/push-notifications version"
src="https://img.shield.io/npm/v/@credo-ts/push-notifications"
/></a>

</p>
<br />

Push Notifications extension module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript.git). It currently implements [Aries RFC 0734](https://github.com/hyperledger/aries-rfcs/tree/main/features/0734-push-notifications-fcm) (Firebase Cloud Messaging) and [Aries RFC 0699](https://github.com/hyperledger/aries-rfcs/tree/main/features/0699-push-notifications-apns) (Apple Push Notifications).
Push Notifications extension module for [Credo](https://github.com/openwallet-foundation/credo-ts.git). It currently implements [Aries RFC 0734](https://github.com/hyperledger/aries-rfcs/tree/main/features/0734-push-notifications-fcm) (Firebase Cloud Messaging) and [Aries RFC 0699](https://github.com/hyperledger/aries-rfcs/tree/main/features/0699-push-notifications-apns) (Apple Push Notifications).

For documentation on installation and usage of the Push Notifications package, refer to the [Docs](https://aries.js.org/guides/0.4/extensions/push-notifications).
8 changes: 4 additions & 4 deletions packages/push-notifications/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@aries-framework/push-notifications",
"name": "@credo-ts/push-notifications",
"main": "build/index",
"types": "build/index",
"version": "0.6.0",
Expand All @@ -10,11 +10,11 @@
"access": "public"
},
"license": "Apache-2.0",
"description": "Push notification plugin for Aries Framework JavaScript",
"homepage": "https://github.com/hyperledger/aries-framework-javascript-ext/tree/main/packages/push-notifications",
"description": "Push notification plugin for Credo",
"homepage": "https://github.com/openwallet-foundation/credo-ts-ext/tree/main/packages/push-notifications",
"repository": {
"type": "git",
"url": "https://github.com/hyperledger/aries-framework-javascript-ext",
"url": "https://github.com/openwallet-foundation/credo-ts-ext",
"directory": "packages/push-notifications"
},
"scripts": {
Expand Down
6 changes: 3 additions & 3 deletions packages/react-hooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
<br />
<img
alt="Hyperledger Aries logo"
src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
src="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
height="250px"
/>
</p>
<h1 align="center"><b>React Hooks for Aries Framework JavaScript</b></h1>
<h1 align="center"><b>React Hooks for Credo</b></h1>
<p align="center">
<a
href="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript-ext/main/LICENSE"
href="https://raw.githubusercontent.com/openwallet-foundation/credo-ts-ext/main/LICENSE"
><img
alt="License"
src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
Expand Down
8 changes: 4 additions & 4 deletions packages/react-hooks/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@aries-framework/react-hooks",
"name": "@credo-ts/react-hooks",
"main": "build/index",
"types": "build/index",
"version": "0.5.0",
Expand All @@ -10,11 +10,11 @@
"access": "public"
},
"license": "Apache-2.0",
"description": "Exposes useful React hooks that allow easy interaction with AFJ.",
"homepage": "https://github.com/hyperledger/aries-framework-javascript-ext/tree/main/packages/react-hooks",
"description": "Exposes useful React hooks that allow easy interaction with Credo.",
"homepage": "https://github.com/openwallet-foundation/credo-ts-ext/tree/main/packages/react-hooks",
"repository": {
"type": "git",
"url": "https://github.com/hyperledger/aries-framework-javascript-ext",
"url": "https://github.com/openwallet-foundation/credo-ts-ext",
"directory": "packages/react-hooks"
},
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/react-hooks/tests/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
describe('@aries-framework/react-hooks', () => {
describe('@credo-ts/react-hooks', () => {
it.todo('React Hooks Tests')
})
Loading

0 comments on commit d485418

Please sign in to comment.