As part of the Docs Tools Next Generation Project, the Docs Worker Pool seeks to make the build process for developers both easier and more scalable for developers.
docker build --tag=workerpool .
docker run \
--env MONGO_ATLAS_USERNAME \
--env MONGO_ATLAS_PASSWORD \
--env AWS_ACCESS_KEY_ID \
--env AWS_SECRET_ACCESS_KEY \
--env GITHUB_BOT_USERNAME \
--env GITHUB_BOT_PASSWORD \
--env DB_NAME \
--env XLARGE \
--env SNOOTY_ENV \
--env FASTLY_TOKEN \
--env FASTLY_DOCHUB_MAP \
--env FASTLY_SERVICE_ID \
workerpool
MONGO_ATLAS_USERNAMEandMONGO_ATLAS_PASSWORDis username/password of atlas databaseAWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYare needed for uploading to S3 via mutGITHUB_BOT_USERNAMEandGITHUB_BOT_PASSWORDare needed so builder can access private reposDB_NAMEallows the indication of a pool database (pool, pool_test)XLARGEtrue or false indicates whether this instance will run on an XLARGE server or notSNOOTY_ENVindicates whether the build environment is stage, prod, or devFASTLY_TOKENis needed for connecting to the Fastly edge dictionaryFASTLY_DOCHUB_MAPis the id of the redirect map that we publish dochub links toFASTLY_SERVICE_IDis the id of the service used for dochub
If you are running a local version of the docker image for testing, we have a separate staging environment setup. Testing in this environment is automated through the "stage" branch. Add the following env variables to the docker run command:
--env DB_NAME
cd worker
npm install --dev
npm test // runs ~ jest --detectOpenHandles --coverage
cd worker
npm install --dev
./node_modules/.bin/eslint .
See the spec doc for more details.