Title
Date: 2024-10-23
Status: proposed
Scope
- [x] backend
- [ ] playground
- [ ] navigation
- [ ] footer
- [ ] top-level-search
- [ ] contact-module
- [ ] global-components-tools
Context
In order to see metadata in Datadog, we provide a service catalogue for our apps via the service.datadog.yamlfile.
There is also a workflow, which updates the metadata, as soon as the file or workflow changes.
Decision
We will put the service declaration file in the root of the repository as opposed to the respective app folder. This is so the actual workflows and paths don't need to be changed.
Consequences
When adding new apps to the monorepo, which will need their own service declaration, we would need to move the file back in the app folder and adjust the GitHub action script accordingly. This is a minor inconvenience, but we believe it is worth it to keep the service declaration file in the root of the repository.