Skip to content

Commit

Permalink
Develop (#1020)
Browse files Browse the repository at this point in the history
* fix

* GitBook: [#56] Correcting errors of API workflow

* new block

Signed-off-by: simvalery <[email protected]>

* refactor

Signed-off-by: simvalery <[email protected]>

* fix ui issues

Signed-off-by: simvalery <[email protected]>

* fix ui issues

Signed-off-by: simvalery <[email protected]>

* add switch block

* fix

* fix

Signed-off-by: Stepan Kiryakov <[email protected]>

* fix

Signed-off-by: Stepan Kiryakov <[email protected]>

* fix lint

Signed-off-by: Stepan Kiryakov <[email protected]>

* added users to demo admin panel

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#57] Added External API, Added Sample MRV data

* fix

* fix

* fix

* fix

* feat: replacing fastMQ with Nats MQ

Signed-off-by: Truong Nguyen <[email protected]>

* displaying available nested blocks

Signed-off-by: artembuslaev <[email protected]>

* added allowed children to action block

Signed-off-by: artembuslaev <[email protected]>

* fix

* GitBook: [#58] Corrected Block Properties of all Blocks

* GitBook: [#59] Added URLs and Ports in Installation file

* GitBook: [#60] Updated Implementation Diagram

* update README.md

Signed-off-by: simvalery <[email protected]>

* update README.md

Signed-off-by: simvalery <[email protected]>

* add block events

* GitBook: [#61] Corrected URLs and Ports

* GitBook: [#62] Updating Prerequisites

* GitBook: [#64] Updated Frameworks/Libraries

* fix view some fields in VC

Signed-off-by: artembuslaev <[email protected]>

* update block registration

Signed-off-by: simvalery <[email protected]>

* fix

* fix build

* Feature/publish docker images (#868)

publish docker images

Signed-off-by: simvalery <[email protected]>

* added env balance variables (#864)

Signed-off-by: artembuslaev <[email protected]>

* fix

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#63] Updating API Workflow of new IREC Demo

* GitBook: [#65] Updating API Workflow of IREC 2

* GitBook: [#66] Updating the API

* GitBook: [#67] No subject

* Feature/publish docker images (#873)

add frontend image

* fix

Signed-off-by: simvalery <[email protected]>

* add policy events

* GitBook: [#69] No subject

* GitBook: [#70] Adding more APIs to iREC 2

* update token creation and importing

Signed-off-by: artembuslaev <[email protected]>

* fixed returns tokens while creation

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#73] No subject

* add event config

* GitBook: [#74] Adding Switch Block

* GitBook: [#75] Redoing API Workflow of iREC 2 Demo

* events

* fix merge

Signed-off-by: simvalery <[email protected]>

* up version

* fix events

* update events

* test

* fix

* archive messages

Signed-off-by: simvalery <[email protected]>

* fix

* fix authorization error code

Signed-off-by: simvalery <[email protected]>

* update events

* fix: error when delete schema (#902)

Signed-off-by: Truong Nguyen <[email protected]>

* fix events

* GitBook: [#80] Updating IREC 2 API Demo

* yarn

Signed-off-by: simvalery <[email protected]>

* implement yarn & workspaces

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: simvalery <[email protected]>

* update dockerfiles

Signed-off-by: simvalery <[email protected]>

* fix Dockerfile

Signed-off-by: simvalery <[email protected]>

* rename service status, fix update status

Signed-off-by: artembuslaev <[email protected]>

* gitignore

* fix

Signed-off-by: simvalery <[email protected]>

* fix

* fix

* fix tests

Signed-off-by: simvalery <[email protected]>

* GitBook: [#81] Updating Policy Definition section

* GitBook: [#82] Added Publish Policy sentence in Demos

* fix undo\redo

* GitBook: [#83] Adding TrustChain APIs in API Demo

* GitBook: [#84] Adding Events information

* publish all refs

Signed-off-by: simvalery <[email protected]>

* 931: fix validate

* get filters

Signed-off-by: simvalery <[email protected]>

* fix filter addons

* fix

* GitBook: [#85] Changes in Events

* fix RA Schema

* fix: trust-chain api get broken

Signed-off-by: Truong Nguyen <[email protected]>

* publish system schema

* update system schema

* revocation functionality

Signed-off-by: artembuslaev <[email protected]>

* fix package-lock.json

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: artembuslaev <[email protected]>

* test

Signed-off-by: simvalery <[email protected]>

* refactoring

* fix import policy

* update system schema

* fix

* GitBook: [#86] Adding FAQs

* data diffs

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: simvalery <[email protected]>

* fix lint

* update swager

* fix

* remove revocation from rejected documents

Signed-off-by: artembuslaev <[email protected]>

* add log

* fix

* added creation of new rejected documents

Signed-off-by: artembuslaev <[email protected]>

* small fix

* update package.json and package-lock.json

* update postman_collection

* GitBook: [#87] Added System Schemas APIs

* fix

Signed-off-by: artembuslaev <[email protected]>

* 967 Renaming Root Authority

* update yarn plugins

Signed-off-by: simvalery <[email protected]>

* change version to current

Signed-off-by: simvalery <[email protected]>

* 965 Units of measure

* fix

* fix

* feat: publish message to nats for external handle

Signed-off-by: Truong Nguyen <[email protected]>

* feat: publish message to nats for external handle

Signed-off-by: Truong Nguyen <[email protected]>

* feat:  merge logger-help to common

Signed-off-by: Truong Nguyen <[email protected]>

* fix trustchain

Signed-off-by: simvalery <[email protected]>

* rejected dialogs

Signed-off-by: artembuslaev <[email protected]>

* fixes

Signed-off-by: simvalery <[email protected]>

* fixes

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

* update unit

* fix

* fix gitignore

Signed-off-by: simvalery <[email protected]>

* Add files via upload

* Delete iRec Application Details.zip

* Update readme.md

* fix import schemas

* Update readme.md

* Update readme.md

* Add files via upload

* Delete Verra REDD 2.zip

* fix docker build

Signed-off-by: simvalery <[email protected]>

* Update readme.md

* GitBook: [#88] Changed the Filenames in the Demos

* GitBook: [#89] Updating new registration screen in both the demos, changing the URL of the new IREC Policy file

* GitBook: [#90] updated the image in Irec 2

* GitBook: [#91] Added Schema and Policy sections

* fix

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#92] Updated Timestamps of iREC and Verra Redd Policies

* add transaction-logger
add hedera net config

* fix

Signed-off-by: artembuslaev <[email protected]>

* add application state

Signed-off-by: simvalery <[email protected]>

* remove max fee

* GitBook: [#93] Added new Blocks : Set Relationships, Button, Revoke Document, updated IREC and Verra Timestamps

* GitBook: [#94] Corrected errors of the Blocks

* GitBook: [#95] Corrected errors in buttonBlock

* fix

* fix

* stack trace of logs

Signed-off-by: artembuslaev <[email protected]>

* update doc

* update doc

* update doc

* fix import

* update doc

* detailed status information

Signed-off-by: artembuslaev <[email protected]>

* update logs

* GitBook: [#96] corrections in the docs

* fix doc

* GitBook: [#97] Policy Demo Steps 1

* disable tabs while loading

Signed-off-by: artembuslaev <[email protected]>

* #803 Hello Message

* fix

* fix

* GitBook: [#98] Policy Demo

* GitBook: [#99] Schema Demo

* fix order of document source block

Signed-off-by: artembuslaev <[email protected]>

* fix error logs

Signed-off-by: simvalery <[email protected]>

* GitBook: [#101] Added two fields in DocumentSourceAddOn

* GitBook: [#102] No subject

* extended logs

* Updated to include stabilizations stage

Added stabilization stage for the release sprint, and adjusted the process accordingly.

* Update RELEASE-MANAGEMENT-PLAN.md

* fix validate policy

* fix configuration errors in logs

Signed-off-by: simvalery <[email protected]>

* fix catch errors

* change schema and policy mime types

Signed-off-by: simvalery <[email protected]>

* increase proxy read timeout

Signed-off-by: simvalery <[email protected]>

* update artifacts

* bump version

Signed-off-by: simvalery <[email protected]>

* add prerelease tag

Signed-off-by: simvalery <[email protected]>

* fix load policy

* add error logs

Signed-off-by: simvalery <[email protected]>

Co-authored-by: Stepan Kiryakov <[email protected]>
Co-authored-by: prernaa.agarwal <[email protected]>
Co-authored-by: artembuslaev <[email protected]>
Co-authored-by: artembuslaev <[email protected]>
Co-authored-by: Stepan Kirjakov <[email protected]>
Co-authored-by: Truong Nguyen <[email protected]>
Co-authored-by: prernaadev01 <[email protected]>
Co-authored-by: daniel.norkin <[email protected]>
Co-authored-by: stepankirjakov <[email protected]>
Co-authored-by: anvabr <[email protected]>
11 people authored Jun 22, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 94d6899 commit eb171ca
Showing 750 changed files with 79,274 additions and 23,638 deletions.
10 changes: 10 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true

[*.{js,json,yml}]
charset = utf-8
indent_style = space
indent_size = 2
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -37,7 +37,7 @@ updates:
open-pull-requests-limit: 5
target-branch: "develop"
- package-ecosystem: npm
directory: "/logger-helper"
directory: "/common"
schedule:
interval: weekly
open-pull-requests-limit: 5
6 changes: 1 addition & 5 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -22,10 +22,6 @@ jobs:
npm install
npm run build
popd
pushd logger-helper
npm install
npm run build
popd
pushd logger-service
npm install
npm run build
@@ -53,7 +49,7 @@ jobs:
pushd interfaces
npm run lint
popd
pushd logger-helper
pushd common
npm run lint
popd
pushd logger-service
37 changes: 11 additions & 26 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,33 +1,18 @@
authentication-service/node_modules/
guardian-service/node_modules/
guardian-service/dist/
ipfs-client/node_modules/
ipfs-client/dist/
logger-service/node_modules/
logger-service/dist/
logger-helper/node_modules/
logger-helper/dist/
ui-service/node_modules/
ui-service/dist/
mrv-sender/node_modules/
mrv-sender/dist/
node_modules/
dist/
.vscode/
vc/node_modules/
vc/dist/
vc-modules/node_modules/
vc-modules/dist/
.vs/
config.keys
interfaces/dist/
interfaces/node_modules/
www-data/
ui-service/.vs/
/test_results/
/api-tests/node_modules/
/api-docs/node_modules/
/auth-service/dist/
/auth-service/node_modules/
/guardian-service/config.json
/threads-test/node_modules/
api-docs/dist/
.env
tsconfig.tsbuildinfo
.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*
node_modules
9 changes: 9 additions & 0 deletions .yarn/plugins/@yarnpkg/plugin-typescript.cjs

Large diffs are not rendered by default.

550 changes: 550 additions & 0 deletions .yarn/plugins/@yarnpkg/plugin-version.cjs

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
nodeLinker: node-modules

plugins:
- path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
spec: "@yarnpkg/plugin-typescript"
- path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
spec: "@yarnpkg/plugin-workspace-tools"
- path: .yarn/plugins/@yarnpkg/plugin-version.cjs
spec: "@yarnpkg/plugin-version"
Binary file added Demo Artifacts/IRec Policy 3.policy
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file added Demo Artifacts/Verra REDD Policy 2.policy
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion Demo Artifacts/irec-policy-config.txt
Original file line number Diff line number Diff line change
@@ -411,7 +411,7 @@
},
{
"id": "9afff85d-2d4a-4874-9a1d-e9c5ec35e923",
"tag": "root_authority_header",
"tag": "standard_registry_header",
"blockType": "interfaceContainerBlock",
"defaultActive": true,
"children": [
11 changes: 6 additions & 5 deletions Demo Artifacts/readme.md
Original file line number Diff line number Diff line change
@@ -2,18 +2,19 @@

This folder contains sample files that are referenced in the Demo Usage Guide from previous versions of the Guardian. As of version 1.0.5 the following files will not be needed to follow the guide:

1. Sample Schema for iRec Policy (`iRec_Application_Details.zip`)
2. Sample Policy Workflow configuration file (`irec-policy-config.txt`)
3. Sample of Verra REDD Policy (`Verra REDD.zip`)
4. Sample Schema design template for Verra REDD Policy (`REDD APD Schema Design Template.xlsx`)
1. Sample Schema of iREC (`iREC Schema.zip`)
2. Sample of iREC Policy (`IRec Policy 3.zip`)
3. Sample Policy Workflow configuration file (`irec-policy-config.txt`)
4. Sample of Verra REDD Policy (`Verra REDD Policy 2.zip`)
5. Sample Schema design template for Verra REDD Policy (`REDD APD Schema Design Template.xlsx`)

We are keeping them in the repo as they may be relevant in future releases.

## Demo Usage Guide

1. The Guardian reference implementation comes with two predefined users:

- **Root Authority**: A standard registry, or a Root Authority in our scenario, is an organization that establishes science-based standards for measuring, reporting, and verifying (MRV) ecological benefit claims and issues value in the form of credit for claims that meet the standard set. A standard registry also authorizes validation and verification bodies (VVBs) to collect and process claims based on the established standard. The creation of scientific-based standards for MRV is a rigorous discipline that requires independence from commercial influence in the pursuit of accurate accounting of benefit or emissions claims. A standard registry organization can also maintain a central registry of credits they have issued that can be sold directly via the registry itself or established as reference value on networks, exchanges, or marketplaces.
- **Standard Registry**: A standard registry, or a Standard Registry in our scenario, is an organization that establishes science-based standards for measuring, reporting, and verifying (MRV) ecological benefit claims and issues value in the form of credit for claims that meet the standard set. A standard registry also authorizes validation and verification bodies (VVBs) to collect and process claims based on the established standard. The creation of scientific-based standards for MRV is a rigorous discipline that requires independence from commercial influence in the pursuit of accurate accounting of benefit or emissions claims. A standard registry organization can also maintain a central registry of credits they have issued that can be sold directly via the registry itself or established as reference value on networks, exchanges, or marketplaces.
- **Auditor**: This is a 3rd part who will need to view/audit the entire chain of events; from the establishment of the science-based standards through creation of the credit.

For complete flow documentation, please refer to https://docs.hedera.com/guardian/demo-guide/demo-usage-guide
22 changes: 0 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -82,22 +82,6 @@ To get a local copy up and running, follow these simple example steps. When buil
npm run build
```

**From the logger-helper folder**

Build package
```sh
npm install
npm run build
```

**From the interfaces folder**

Build package
```sh
npm install
npm run build
```


**From the common folder**

@@ -107,12 +91,6 @@ To get a local copy up and running, follow these simple example steps. When buil
npm run build
```

**From the logger-helper folder**

Build package
```sh
npm install
npm run build
```
**From the Logger service folder**
42 changes: 25 additions & 17 deletions RELEASE-MANAGEMENT-PLAN.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ This document describes general approach to release management for the Guardian

### Release schedule and numbering

The Guardian development team follows Scrum methodology with 2-week sprints. Software releases are produced on regular cadence every other sprint, i.e every 4 weeks; regardless of the status of features in development. Releases are produced on Mondays at 12:00 EST, following the go/no-go decisition taken at the end-of-sprint review on Friday previous week.
The Guardian development team follows Scrum methodology with 2-week sprints. Software releases are produced on regular cadence every other sprint, i.e every 4 weeks; regardless of the status of features in development. Releases are produced on Tuesdays at 12:00 EST, following the go/no-go decisition taken at the end-of-sprint review on Friday previous week.

The Guardian uses semantic versioning for releases in the major.minor.build format. Each number incremented sequentially to denote the following changes:
- major: a significant milestone in product lifecycle has been reached
@@ -13,7 +13,10 @@ The Guardian uses semantic versioning for releases in the major.minor.build form
Guardian version numbers also reflect changes in the API delivered by the release. Detailed description of the API lifecycle management and versioning is available in the [API Versioning and Deprecation Policy](https://docs.hedera.com/guardian/getting-started/api-versioning-and-deprecation-policy).

### Release process
The Guardian release process is built around the sprint cycle, where each sprint ends with the codebase in the 'releasable' state. The only difference between the alternating release sprints and non-release sprints is the activities of packaging and uploading artifacts into external repositories.
The Guardian release process is built around the sprint cycle, where each sprint ends with the codebase in the 'releasable' state. The difference between the alternating release sprints and non-release sprints is in the set of activities forming the release:
- tagging the codebase with the release tag.
- release testing.
- packaging and uploading artifacts into external repositories.

#### Feature development cycle
An inception-to-release lifecycle of a new enchacement is usually 3 sprints long:
@@ -45,25 +48,30 @@ After the Sprint ended, the Product Owner leads the Sprint Review ceremony on Mo
- Product Owner delivers a sprint report (with charts and statistics of the sprint)
- Developers demo completed features, which includes showing unit tests and documentation (where relevant). For features without exposure through a UI developers will demo the successful run of the unit test.

Following the Sprint Review lead developer tags and merges 'Develop' into 'Main'.

On Tuesday the Product Owner holds a 'Retrospective' meeting where developers discuss between themselves successes/failures of the previous sprint and opportunities for improvements.

#### Release flow

Release sprint contain additional activities:
- Documentation review by the Product Manager
- Unit tests verification by the lead developer
- Demo environment sanity tested by lead developer, product team and/or stakeholders
- Product Manager prepares ChangeLog document
- Product Manager prepares Release notes
- Product Manager tags the release and runs release CI pipeline, following which verifies that it completed successfully and all artefacts got uploaded to the correct repositories
- Product Manager tags the Develop branch with the new version
- Product Manager or Lead developer creates a PR and squash-merges into the update from the Develop into the Main branch
- Product Manager tags the Main branch
- Produt Manager makes a release in the Main branch
- Product Owner posts community announcements in the discord and slack channels

Development release cycle consists of two sprints: development sprint followed by the release sprint. Development sprint is fully dedicated to normal development activities, release sprints contain consist of two stages:
- a week-long development stage (the same as in the development sprint), which ends with the 'code freeze'
- a week-long 'stabilization' stage, during which team resources are allocated to testing, bug fixing and documentation. No new development work is performed during this period.

The 'stabilisation' stage of the release sprint starts the following additional activities:
- Product Manager tags the release and runs release CI pipeline, following which verifies that it completed successfully.
- Product Manager tags the Develop branch with the new pre-release version.
- Product Manager or Lead developer creates a PR and squash-merges into the update from the Develop into the Main branch.
- Product Manager tags the Main branch with the **pre-release**.
- Product Manager makes a **pre-release** in the Main branch.
- Product Manager prepares a pre-release ChangeLog document.
- Product Manager prepares a pre-release Release notes.
- Product Owner posts community announcements in the discord and slack channels about the availability of the pre-release, to enable members of the community to assess the release impact and prepare for the upgrade.

The entire team, with the help of the wider community, tests the Release for a week, fixing defects, developing additional unit-tests, and improving/fixing documentation. Other activities include:
- Documentation review by the Product Manager, Product Owner and stakeholders.
- Unit tests verification by the lead developer.
- Demo environment sanity tested by lead developer, product team and/or stakeholders.

At the end of the release sprint Product Owner facilitates the discussion with Product Manager and members of the Dev and QA teams on the release go/no-go decisions. Following a positive decision the PM tags the codebase with the release version and makes the release ensuring all release artefacts get uploaded into their distribution repositories.

#### Artifacts list

Loading

0 comments on commit eb171ca

Please sign in to comment.