honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/aio/aio-builds-setup/docs/overview--scripts-and-comma...

2.6 KiB
Raw Blame History

Overview - Scripts and Commands

This is an overview of the available scripts and commands.

Scripts

The scripts are located inside <aio-builds-setup-dir>/scripts/. The following scripts are available:

  • create-image.sh: Can be used for creating a preconfigured docker image. See here for more info.

  • test.sh: Can be used for running the tests for <aio-builds-setup-dir>/dockerbuild/scripts-js/. This is useful for CI integration. See here for more info.

  • update-preview-server.sh: Can be used for updating the docker container (and image) based on the latest changes checked out from a git repository. See here for more info.

Production Commands

The following commands are available globally from inside the docker container. They are either used by the container to perform its various operations or can be used ad-hoc, mainly for testing purposes. Each command is backed by a corresponding script inside <aio-builds-setup-dir>/dockerbuild/scripts-sh/.

  • aio-clean-up: Cleans up the builds directory by removing the artifacts that do not correspond to an open PR. It is run as a daily cronjob.

  • aio-health-check: Runs a basic health-check, verifying that the necessary services are running, the servers are responding and there is a working internet connection. It is used periodically by docker for determining the container's health status.

  • aio-init: Initializes the container (mainly by starting the necessary services). It is run (by default) when starting the container.

  • aio-preview-server-prod: Spins up a Node.js preview-server instance. It is used in aio-init (see above) during initialization.

Developer Commands

  • aio-preview-server-test: Spins up a Node.js preview-server instance for tests. It is used in aio-verify-setup (see below) for running tests.

  • aio-verify-setup: Runs a suite of e2e-like tests, mainly verifying the correct (inter)operation of nginx and the Node.js preview-server.

  • aio-verify-setup-and-log: Runs the aio-verify-setup command but also then dumps the logs from the preview server, which gives additional useful debugging information. See the debugging docs for more info.

  • aio-dev-mode: Links external source files (from the Docker host) to interal source files (in the Docker container). This makes it easier to use an IDE to edit files in the host that are then tested in the container. See the debugging docs for more info.