mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-30 17:00:57 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10674 from owncloud/update_new_service_checklist

Browse Source 
[docs-only] Update the new service checklist
This commit is contained in:
Martin
2024-11-29 15:44:39 +01:00
committed by GitHub
parent 3f26e0f568 47bd5735e4
commit b6b9af8e2f
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/services/general-info/new-service-checklist.md
View File

@@ -24,13 +24,18 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
bad `<img src="https://github.com/owncloud/ocis/blob/master/services/graph/images/mermaid-graph.svg" width="500" />`
good `<img src="https://raw.githubusercontent.com/owncloud/ocis/master/services/graph/images/mermaid-graph.svg" width="500" />`
- [ ] If new CLI commands are introduced, those commands must be described in the README.md.
- Commands are added to `ocis/pkg/command`
- [ ] If new global envvars are introduced, the name must start with `OCIS_`.
- [ ] Add the service to the makefile in the ocis repo root.
- [ ] Make the service startable for binary and individual startup:
- For single binary add service to `ocis/pkg/runtime`
- For individual startup add service to `ocis/pkg/commands`
- [ ] Service startup:
- add it to `ocis/pkg/command/services.go`
- Include for automatic startup:
- add it to `ocis/pkg/runtime/service/service.go`
- Exclude from automatic startup:
- add it to the `populate optional services` block in `ocis/pkg/runtime/service/service.go`
- Add the service config to `ocis-pkg/config/defaultconfig.go`
- [ ] If the service is using service accounts, add it to `ocis/pkg/init/init.go`
- [ ] Check that the service properly responds to `ocis <service-name> health` and has `/healthz` and `/readyz` endpoints
- [ ] Add the service to `.drone.star` to enable CI.
- [ ] Inform doc team in an *early stage* to review the readme AND the environment variables created.
- The description must reflect the behaviour AND usually has a positive code quality impact.
@@ -45,4 +50,5 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
- [ ] Add metrics to the code to enable monitoring. See the proxy service for implementation details.
- Plus add documentation about monitoring in the README.md file
- [ ] When the service requires translations that have to be covered by the service and are not sourced by web, see the [add translation]({{< ref "./add-translations.md" >}}) documentation for more details.
- [ ] If the service requires a `cache` or `store`, check existing services for implementation and add a documentation in the README.md
```