From bbd8a960b2f0c60df58565d88e80abf6ac2515f1 Mon Sep 17 00:00:00 2001 From: tituschewxj Date: Tue, 12 Nov 2024 19:14:11 +0800 Subject: [PATCH] docs: add lines to ci/cd guide --- docs/cicid.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/cicid.md b/docs/cicid.md index d234b54bbf..2347a42786 100644 --- a/docs/cicid.md +++ b/docs/cicid.md @@ -33,14 +33,17 @@ For CI, Selenium and a publicly available webdriver for Chrome was downloaded. A ## Jobs in CI Workflow 1. question-service-test + a. This job handles testing for the Question Service, which is dependent on Firebase and Go. b. It sets up the environment variables, firebase credentials, Go environment and dependencies and runs tests with firebase emulator. 2. frontend-unit-tests + a. This job tests the frontend application using Node.js and pnpm b. It sets up the environment and Node.js and installs pnpm and dependencies, before running the frontend tests. 3. test-docker-compose + a. This job uses Docker Compose to run multiple services together and validate inter-service connectivity. b. It sets up the environment files and database credential files across all services and builds and runs services with Docker Compose. c. The services’ availability are checked using curl and websocat to validate the HTTP endpoints and WebSocket endpoints respectively.