@coweb/notification-endpoint v0.1.1
COW: \<component> / \<subservice>
In order to create a new subservice:
1. Create project in GitLab
2. Pull project to your local development branch
3. Copy and paste this project (except .git
directory) to the newly created project
4. If you are creating an
application: overwrite content of .gitlab-ci.yml
with app.gitlab-ci.yml
front-end server: apply application steps and overwrite content of Dockerfile
with httpd-Dockerfile
(also you can change the public directory given in it) and change entrypoint in cow.yml to httpd-foreground
. You may delete anything related to typescript backend. Update the scripts to match your requirements.
library: delete app related entities from package.json (@coweb/cow
, express
, etc...)
5. Rename every project-template
you see in the files to either component-subservice
or indicate otherwise. (In some places there are also only project
or template
, rename those accordingly to your component and subservice names, too)
6. git commit -am "feat: initial commit"
7. git push
8. Open project in GitLab and go to Settings -> CI/CD
Under General Pipelines change Test Coverage Parsing to : All files\s*\|\s*(\d+).*
Under Runners activate COW Runner for your project
Under Variables add Protected variables of:
GL_TOKEN : <copy from this project's settings>
NPM_TOKEN : <copy from this project's settings>
CI_DOCKER_PASSWORD: <copy from this project's settings> (not necessary for a library)
IMPORTANT: Do not commit these values to Git
* TODO: We actually have to move this to runner's Kubernetes secrets
8. Delete these steps and write something meaningful that explains the purpose of the subservice.
9. Start coding!