a97de2e2a9 | ||
---|---|---|
.. | ||
README.md | ||
assert-branch.sh | ||
base-install.sh | ||
build-all.sh | ||
build-and-deploy-fxa-circleci.sh | ||
build.sh | ||
config.yml | ||
deploy-all.sh | ||
deploy.sh | ||
modules-to-test.js | ||
test-package.sh |
README.md
CircleCI
config.yml
defines the jobs and workflows of our CircleCI deployment.
Special Cases
fxa-email-service
isn't tested for most PRs because it doesn't change
often and is relatively resource intensive. In order to
trigger these tests the PR branch should be prefixed with email-service-
.
PRs that change those packages on other branches will (intentionally) fail.
Scripts
This directory contains scripts used by config.yml
to run jobs. More
general scripts should be located in ../_scripts
or in individual
package directories.
Conventions
Tests
Packages are tested with ./test-package.sh
. The default action is to run:
yarn install
yarn test
Packages may define a scripts/test-ci.sh
as a custom test script.
Builds
By default packages are built using docker. The standard Dockerfile
is the preferred method. Packages may define a scripts/build-ci.sh
as a custom build script.
Deploys
Packages that create docker images are deployed to docker hub.
New packages require username and password environment variables in CircleCI project settings in order to deploy.
Local Testing
With the CircleCI CLI you can run some jobs locally. Deploy jobs will fail to run.
For example, to run the test-many
job:
circleci config process .circleci/config.yml > .circleci/local.yml
circleci local execute -c .circleci/local.yml --job test-many