Skip to content

Commit 21a642f

Browse files
committed
Merge branch 'main' of https://github.com/bcgov/traction into release/0.4.0
2 parents f8dbc71 + fcc696f commit 21a642f

22 files changed

+101
-81
lines changed

.github/dependabot.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# For details on how this file works refer to:
2+
# - https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
3+
version: 2
4+
updates:
5+
# Maintain dependencies for GitHub Actions
6+
# - Check for updates once a week
7+
# - Group all updates into a single PR
8+
- package-ecosystem: github-actions
9+
directory: /
10+
schedule:
11+
interval: weekly
12+
groups:
13+
all-actions:
14+
patterns: [ "*" ]

.github/workflows/build_deploy_tenant_ui.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
runs-on: ubuntu-20.04
3030
if: github.repository_owner == 'bcgov'
3131
steps:
32-
- uses: actions/checkout@v2
32+
- uses: actions/checkout@v4
3333
with:
3434
ref: ${{ github.event.inputs.ref }}
3535

@@ -55,7 +55,7 @@ jobs:
5555
if: ${{ always() && contains(needs.*.result, 'success') && !(contains(needs.*.result, 'failure')) && (github.repository_owner == 'bcgov') }}
5656

5757
steps:
58-
- uses: actions/checkout@v2
58+
- uses: actions/checkout@v4
5959

6060
- name: Authenticate and set context
6161
uses: redhat-actions/oc-login@v1

.github/workflows/chart_release.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515
- name: Checkout
16-
uses: actions/checkout@v3
16+
uses: actions/checkout@v4
1717
with:
1818
ref: gh-pages
1919
- name: Download remote index file and check equality
@@ -29,7 +29,7 @@ jobs:
2929
runs-on: ubuntu-latest
3030
needs: [ validate-gh-pages-index ]
3131
steps:
32-
- uses: actions/checkout@v3
32+
- uses: actions/checkout@v4
3333
with:
3434
fetch-depth: 0
3535
- name: Configure Git

.github/workflows/on_pr_closed.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ jobs:
1818
runs-on: ubuntu-22.04
1919
if: github.repository_owner == 'bcgov'
2020
steps:
21-
- uses: actions/checkout@v2
21+
- uses: actions/checkout@v4
2222
- name: Check out manifest repo
23-
uses: actions/checkout@v2
23+
uses: actions/checkout@v4
2424
with:
2525
ssh-key: ${{ secrets.MANIFEST_REPO_DEPLOY_KEY }}
2626
repository: ${{ secrets.MANIFEST_REPO }}

.github/workflows/on_pr_opened.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
needs:
3535
- ready
3636
steps:
37-
- uses: actions/checkout@v3
37+
- uses: actions/checkout@v4
3838
- name: Build UI
3939
uses: ./.github/actions/build_ui
4040
id: builder
@@ -56,7 +56,7 @@ jobs:
5656
needs:
5757
- ready
5858
steps:
59-
- uses: actions/checkout@v3
59+
- uses: actions/checkout@v4
6060
- name: Build Aca-Py Image
6161
uses: ./.github/actions/build_acapy
6262
id: builder
@@ -77,7 +77,7 @@ jobs:
7777
needs:
7878
- ready
7979
steps:
80-
- uses: actions/checkout@v3
80+
- uses: actions/checkout@v4
8181
- name: Build Tenant Proxy Image
8282
uses: ./.github/actions/build_acapy
8383
id: builder
@@ -103,7 +103,7 @@ jobs:
103103
if: ${{ always() && (fromJSON(needs.ready.outputs.deploy) == true) && !(contains(needs.*.result, 'failure')) }}
104104

105105
steps:
106-
- uses: actions/checkout@v3
106+
- uses: actions/checkout@v4
107107

108108
- name: Authenticate and set context
109109
uses: redhat-actions/oc-login@v1
@@ -130,10 +130,10 @@ jobs:
130130
- deploy
131131
if: ${{ (fromJSON(needs.ready.outputs.deploy) == true) && !(contains(needs.*.result, 'failure')) }}
132132
steps:
133-
- uses: actions/checkout@v3
133+
- uses: actions/checkout@v4
134134

135135
- name: Find Comment
136-
uses: peter-evans/find-comment@v1
136+
uses: peter-evans/find-comment@v3
137137
id: fc
138138
with:
139139
issue-number: ${{ github.event.number }}
@@ -142,7 +142,7 @@ jobs:
142142

143143
- name: Create comment
144144
if: steps.fc.outputs.comment-id == ''
145-
uses: peter-evans/create-or-update-comment@v1
145+
uses: peter-evans/create-or-update-comment@v4
146146
with:
147147
issue-number: ${{ github.event.number }}
148148
body: |

.github/workflows/on_push_main.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ubuntu-latest
1616
if: github.repository_owner == 'bcgov'
1717
steps:
18-
- uses: actions/checkout@v3
18+
- uses: actions/checkout@v4
1919
- name: Build service
2020
uses: ./.github/actions/build_ui
2121
id: builder
@@ -34,7 +34,7 @@ jobs:
3434
runs-on: ubuntu-latest
3535
if: github.repository_owner == 'bcgov'
3636
steps:
37-
- uses: actions/checkout@v3
37+
- uses: actions/checkout@v4
3838
- name: Build Aca-Py Image
3939
uses: ./.github/actions/build_acapy
4040
id: builder
@@ -54,7 +54,7 @@ jobs:
5454
runs-on: ubuntu-latest
5555
if: github.repository_owner == 'bcgov'
5656
steps:
57-
- uses: actions/checkout@v3
57+
- uses: actions/checkout@v4
5858
- name: Build Aca-Py Image
5959
uses: ./.github/actions/build_acapy
6060
id: builder
@@ -80,7 +80,7 @@ jobs:
8080
if: ${{ always() && contains(needs.*.result, 'success') && !(contains(needs.*.result, 'failure')) && (github.repository_owner == 'bcgov') }}
8181

8282
steps:
83-
- uses: actions/checkout@v3
83+
- uses: actions/checkout@v4
8484

8585
- name: Authenticate and set context
8686
uses: redhat-actions/oc-login@v1

.github/workflows/release_assets.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
runs-on: ubuntu-latest
1717
if: github.repository_owner == 'bcgov'
1818
steps:
19-
- uses: actions/checkout@v3
19+
- uses: actions/checkout@v4
2020
- name: Build Aca-Py Image
2121
uses: ./.github/actions/build_acapy
2222
id: builder
@@ -33,7 +33,7 @@ jobs:
3333
runs-on: ubuntu-latest
3434
if: github.repository_owner == 'bcgov'
3535
steps:
36-
- uses: actions/checkout@v3
36+
- uses: actions/checkout@v4
3737
- name: Build UI
3838
uses: ./.github/actions/build_ui
3939
id: builder
@@ -49,7 +49,7 @@ jobs:
4949
runs-on: ubuntu-latest
5050
if: github.repository_owner == 'bcgov'
5151
steps:
52-
- uses: actions/checkout@v3
52+
- uses: actions/checkout@v4
5353
- name: Build Tenant Proxy Image
5454
uses: ./.github/actions/build_acapy
5555
id: builder

.github/workflows/stale.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
stale:
1010
runs-on: ubuntu-22.04
1111
steps:
12-
- uses: actions/stale@v8
12+
- uses: actions/stale@v9
1313
with:
1414
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
1515
stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'

.github/workflows/test_tenant_ui.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ jobs:
2222
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
2323

2424
steps:
25-
- uses: actions/checkout@v3
25+
- uses: actions/checkout@v4
2626
- name: Use Node.js ${{ matrix.node-version }}
27-
uses: actions/setup-node@v3
27+
uses: actions/setup-node@v4
2828
with:
2929
node-version: ${{ matrix.node-version }}
3030
cache: "npm"
@@ -45,9 +45,9 @@ jobs:
4545
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
4646

4747
steps:
48-
- uses: actions/checkout@v3
48+
- uses: actions/checkout@v4
4949
- name: Use Node.js ${{ matrix.node-version }}
50-
uses: actions/setup-node@v3
50+
uses: actions/setup-node@v4
5151
with:
5252
node-version: ${{ matrix.node-version }}
5353
cache: "npm"

README.md

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Traction
1+
# Traction
22

33
![Traction Logo](./docs/assets/readme-logo.png)
44

5-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) [![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](<Redirect-URL>) [![Maintainability](https://api.codeclimate.com/v1/badges/e6df50041dd4373c7e15/maintainability)](https://codeclimate.com/github/bcgov/traction/maintainability)
5+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) [![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](<Redirect-URL>) [![Maintainability](https://api.codeclimate.com/v1/badges/e6df50041dd4373c7e15/maintainability)](https://codeclimate.com/github/bcgov/traction/maintainability)
66

77

8-
## Table of Contents
8+
## Table of Contents
99

1010
- [What is Traction?](#what-is-traction)
1111
- [Start using Traction](#start-using-traction)
@@ -17,54 +17,54 @@
1717
- [Engage with the community](#engage-with-the-community)
1818

1919

20+
## What is Traction?
2021

21-
## What is Traction?
22+
Traction is a digital wallet solution comprised of plugins layered on top of Hyperledger Aries Cloud Agent Python (ACA-Py) and streamlines the process of sending and receiving digital credentials for governments and organizations.
2223

23-
Traction is a digital wallet solution comprised of plugins layered on top of Hyperledger Aries Cloud Agent Python (ACA-Py) and streamlines the process of sending and receiving digital credentials for governments and organizations.
24-
25-
Its open-source foundation makes it easy to integrate digital trust technology into existing lines of business applications, without having to stand up, maintain and manage an instance of ACA-Py themselves. Future functionality could include machine-readable governance and more.
24+
Its open-source foundation makes it easy to integrate digital trust technology into existing lines of business applications, without having to stand up, maintain and manage an instance of ACA-Py themselves. Future functionality could include machine-readable governance and more.
2625

2726
![Arch Diagram](./docs/assets/traction-flow-chart-1600x900-12162022-01.jpg)
2827

2928
## Play in the Traction Sandbox
3029

31-
Establish your own Traction tenant in a B.C. Government sandbox to issue, hold, present, and verify digital credentials using these [setup instructions](./docs/traction-anoncreds-workshop.md).
30+
Establish your own Traction tenant in a B.C. Government sandbox to issue, hold, present, and verify digital credentials using these [setup instructions](./docs/traction-anoncreds-workshop.md).
31+
32+
**Disclaimer**: On the 1st and 15th of each month, the entire sandbox gets reset and all your work will be gone.
3233

33-
**Disclaimer**: On the 1st and 15th of each month, the entire sandbox gets reset and all your work will be gone.
34+
## Start using Traction
3435

35-
## Start using Traction
36+
**Running Traction**: to run a local instance of traction, see the documentation in [scripts](./scripts/README.md).
3637

37-
**Running Traction**: to run a local instance of traction, see the documentation in [scripts](./scripts/README.md).
38+
**Deploying Traction**: Helm charts for deploying Traction to Kubernetes: [charts](./charts/README.md).
3839

39-
**Deploying Traction**: Helm charts for deploying Traction to Kubernetes: [charts](./charts/README.md).
4040

41+
## What are the benefits of using Traction?
4142

42-
## What are the benefits of using Traction?
43+
Traction makes it easier to integrate digital trust technology into existing line of business applications.
4344

44-
Traction makes it easier to integrate digital trust technology into existing line of business applications.
45+
- **API-first Architecture**: Traction is designed with an API-first architecture, this RESTful API allows for integration into existing line-of-business applications already being used by organizations, the Tenant user interface is built on this API to enable adoption prior to integration and for low-use functions.
46+
- **Enhanced Interoperability**: Hyperledger Aries makes Traction more broadly compatible with existing technologies used by governments and organizations around the world.
47+
- **Multi-tenancy**: Rather than having multiple digital tools to integrate with organizations, one scalable instance of Traction can be used to participate in the digital trust ecosystem, control all connections, and more easily share data.
48+
- **Higher Scalability**: Traction is open-source technology, encouraging collaborative refinement, faster release, and higher scalability.
4549

46-
- **API-first Architecture**: Traction is designed with an API-first architecture, this RESTful API allows for integration into existing line-of-business applications already being used by organizations, the Tenant user interface is built on this API to enable adoption prior to integration and for low-use functions.
47-
- **Enhanced Interoperability**: Hyperledger Aries makes Traction more broadly compatible with existing technologies used by governments and organizations around the world.
48-
- **Multi-tenancy**: Rather than having multiple digital tools to integrate with organizations, one scalable instance of Traction can be used to participate in the digital trust ecosystem, control all connections, and more easily share data.
49-
- **Higher Scalability**: Traction is open-source technology, encouraging collaborative refinement, faster release, and higher scalability.
5050

51+
## What is Traction comprised of?
5152

52-
## What is Traction comprised of?
53+
- [ACA-Py + plugins](./plugins/README.md)
54+
- [Tenant UI](./services/tenant-ui/README.md)
55+
- [Endorser Services](./services/endorser/README.md)
5356

54-
- [ACA-Py + plugins](./plugins/README.md)
55-
- [Tenant UI](./services/tenant-ui/README.md)
56-
- [Endorser Services](./services/endorser/README.md)
5757

58+
## Start contributing to Traction
5859

59-
## Start contributing to Traction
60+
Traction is an open-source technology project that welcomes collaboration.
6061

61-
Traction is an open-source technology project that welcomes collaboration.
62+
If you would like to contribute to Traction, please review the following:
6263

63-
If you would like to contribute to Traction, please review the following:
64+
- [Contributing](./CONTRIBUTING.md)
65+
- [Code of Conduct](./CODE_OF_CONDUCT.md)
66+
- [Compliance](./COMPLIANCE.yaml)
6467

65-
- [Contributing](./CONTRIBUTING.md)
66-
- [Code of Conduct](./CODE_OF_CONDUCT.md)
67-
- [Compliance](./COMPLIANCE.yaml)
6868

6969
## Developers: devcontainers
7070
To aid in developers, there are 2 `devcontainers`: [plugins](./plugins/.devcontainer/devcontainer.json) and [tenant-ui](./services/tenant-ui/.devcontainer/devcontainer.json).
@@ -95,7 +95,6 @@ Note that Tenant Proxy and Traction DB are started via docker compose when start
9595
### Repository workflow
9696
Currently authorized users can create a branch and run a pull request to merge in changes. Unauthorized can always create a fork.
9797

98-
9998
#### Rebasing of a branch
10099
```bash
101100
git fetch --all
@@ -105,22 +104,22 @@ git rebase origin/main
105104
git push --force
106105
```
107106

108-
## Who is maintaining Traction?
107+
## Who is maintaining Traction?
109108
[The Province of British Columbia](https://github.com/bcgov/) is maintaining Traction as an open-source project.
110109

111-
Maintainer(s):
110+
Maintainer(s):
112111
- Jason Sherman
113112
- Jason Syrotuck
114113
- Lucas O'Neil
115114
- Jamie Popkin
116115

117-
## How is Traction licensed?
116+
## How is Traction licensed?
118117

119-
Traction is licensed under Apache License 2.0 which can be reviewed [here](./LICENSE).
118+
Traction is licensed under Apache License 2.0 which can be reviewed [here](./LICENSE).
120119

121120

122-
## Engage with the community
121+
## Engage with the community
123122

124123
Connect with others
125-
- on Discord: [EMDT Public Discord Channel](https://discord.com/channels/766403442599657522/854432442382680104)
124+
- on Discord: [EMDT Public Discord Channel](https://discord.com/channels/766403442599657522/854432442382680104)
126125
- for Aries discussion see the Hyperlerger Aries Github [participation section](https://github.com/hyperledger/aries#project-participation)

0 commit comments

Comments
 (0)