Skip to content

Commit

Permalink
chore: Describe the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
fmarek-kindred committed Jul 15, 2024
1 parent e512a06 commit e3d2f14
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 29 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,19 @@

[comment]: <> (TOC_START)

- [Overview](#overview)
- [Getting Started](#getting-started)
- [Requirements](#getting-started-requirements)
- [Installation and setup.](#getting-started-installation-and-setup)
- [Rust Scripts](#getting-started-rust-scripts)
- [Committing Code](#getting-started-committing-code)
- [IDE's](#ides)
- [VSCODE Settings](#ides-vscode-settings)
- [Usage](#usage)
- [Release Notes](#release-notes)
- [Talos](#talos)
- [Overview ](#overview-)
- [Getting Started ](#getting-started-)
- [Requirements ](#requirements-)
- [Installation and setup. ](#installation-and-setup-)
- [Rust Scripts ](#rust-scripts-)
- [Committing Code ](#committing-code-)
- [IDE's ](#ides-)
- [VSCODE Settings ](#vscode-settings-)
- [Usage ](#usage-)
- [Cohort Reference Implementation](#cohort-reference-implementation)
- [Release Process ](#release-process-)
- [Release Notes ](#release-notes-)

[comment]: <> (TOC_END)

Expand All @@ -30,7 +33,7 @@ Talos is based on the STRIDE algorithm for strict serializable certification of
### Requirements <a name="getting-started-requirements"></a>

- [docker (20.10.6)](https://docs.docker.com/get-docker/)
- [cargo (1.68.0), rust (1.68.0)](https://www.rust-lang.org/tools/install) only required if wanting to run outside of docker
- [cargo (1.75.0), rust (1.75.0)](https://www.rust-lang.org/tools/install) only required if wanting to run outside of docker
- openssl for SASL supports

### Installation and setup. <a name="getting-started-installation-and-setup"></a>
Expand Down Expand Up @@ -98,4 +101,8 @@ Once you have checked, tested and linted your code you may create a commit.
### Cohort Reference Implementation
![Cohort architecture](docs/cohort-arch.png)

## Release Process <a name="release"></a>

The release process is explained in the separate document: [README-release.md](/README-release.md)

## Release Notes <a name="release-notes"></a>
30 changes: 15 additions & 15 deletions cohort_banking_initiator_js/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cohort_banking_initiator_js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"typescript": "^5.1.6"
},
"dependencies": {
"@kindredgroup/cohort_sdk_client": "0.2.12",
"@kindredgroup/cohort_sdk_client": "0.2.13",
"pg": "^8.11.3",
"winston": "^3.10.0"
}
Expand Down
2 changes: 1 addition & 1 deletion cohort_banking_replicator_js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"typescript": "^5.1.6"
},
"dependencies": {
"@kindredgroup/cohort_sdk_client": "^0.2.12",
"@kindredgroup/cohort_sdk_client": "^0.2.13",
"pg": "^8.11.3",
"winston": "^3.10.0"
}
Expand Down
2 changes: 1 addition & 1 deletion cohort_sdk_client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.2.14-dev",
"author": "Kindredgroup",
"license": "MIT",
"description": "",
"description": "The Cohort SDK library for Talos Certifier clients",
"type": "commonjs",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit e3d2f14

Please sign in to comment.