docs: Repo layout and contribution guide#47
docs: Repo layout and contribution guide#47carlosthe19916 merged 1 commit intotrustification:mainfrom
Conversation
* describe the repository layout * describe how to contribute an API or a UI test Resolves: trustification#43 (trustification#43) Signed-off-by: Jiří Kučera <jkucera@redhat.com>
|
|
||
| - `openapi.yaml` - a file with the [Trustify](https://github.com/trustification/trustify) | ||
| API definition; every time the file changes on the [Trustify](https://github.com/trustification/trustify) | ||
| side it should be also updated here |
There was a problem hiding this comment.
As explained on elsewhere, atm we are not going to use the hey-api generated Sdk/Client/Types, due to overall preference of directly seeing the url/headers/params covered by api test inside the test code, instead of intermediate helpers.
As such, the is no need to keep this file updated ...
... depending on if we later find good use case for it, then it should be kept up to date (automatically), and if not then these parts can be dropped (for now since it was already implemented it can stay around until there is bigger progress and better understanding of maintaining the api tests).
Same would apply to following parts and sections too.
There was a problem hiding this comment.
In case you guys find this useful https://github.com/trustification/trustify/blob/main/.github/workflows/openapi.yaml
That is the Gh Action that automatically pushes the openapi.yaml file to the UI repository to automatically. Just sharing in case you would like to have a similar thing here.
3 participants
Describe the repository layout and add a brief contribution guidelines.
Resolves: #43