-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add decision record about the adoption of IATP (#145)
* docs: add decision record about the adoption or IATP * DEPENDENCIES * wording
- Loading branch information
1 parent
e875d8d
commit 9edabd6
Showing
2 changed files
with
41 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
...cision-records/2023-09-27-adoption_of_the_identity_and_trust_protocol/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Identity Hub - Adoption of the Identity And Trust Protocols | ||
|
||
## Decision | ||
|
||
The Identity Hub component will adopt the Identity And Trust Protocols ( | ||
cf. [this decision-record](https://github.com/eclipse-edc/docs/tree/e7730f432305775542503e4ecb61aa7e829bea30/developer/decision-records/2023-09-06-identity-trust)). | ||
To that end, the current content of the repository will be preserved in a branch named `identity_dwn` (to indicate the | ||
partial implementation of the DWN Spec). | ||
|
||
All further developments will happen on the `main` branch. | ||
|
||
## Rationale | ||
|
||
The adoption of the Identity and Trust Protocols spec may bring some substantial changes, for example it will introduce | ||
a series of new APIs. | ||
|
||
The entire work package is too large to be done in one feature branch, so we will do the adoption iteratively. | ||
|
||
To avoid potential conflicts with existing implementations (model classes, interfaces, etc.) the current state of the | ||
IdentityHub will be preserved in a separate branch. | ||
|
||
It's generally just good practice to have the `main` branch reflect the most recent state of development, but there are | ||
other, more technical advantages as well: | ||
|
||
- some GitHub actions only run on the `main` branch | ||
- dependabot only inspects the `main` branch | ||
- new workflows are only detected once they are available on the `main` branch | ||
- cloning the repo by default clones the `main` branch | ||
- newly created PRs by default target the `main` branch. Doing ongoing dev work on any other branch would be a | ||
significant risk of PRs targeting the wrong head branch. While it's not a big issue, it can be an annoying one. | ||
|
||
## Approach | ||
|
||
- create a new branch `identity_dwn` | ||
- add architecture documents | ||
- add GitHub issues for the upcoming developments |