CircleCI supports many advanced configuration options and features, check out the snippets below to get an idea of what is possible, and get tips for optimizing your advanced configurations.
Check your scripts
Use the shellcheck orb to check all scripts in a project. Check the shellcheck page in the orb registry for versioning and further usage examples (remember to replace x.y.z with a valid version):
version: 2.1 orbs: shellcheck: firstname.lastname@example.org workflows: shellcheck: jobs: - shellcheck/check
You can also use shellcheck with version 2 config, without using the orb, as follows:
version: 2 jobs: shellcheck: docker: - image: nlknguyen/alpine-shellcheck:v0.4.6 auth: username: mydockerhub-user password: $DOCKERHUB_PASSWORD # context / project UI env-var reference steps: - checkout - run: name: Check Scripts command: | find . -type f -name '*.sh' | wc -l find . -type f -name '*.sh' | xargs shellcheck --external-sources
For more information on using shell scripts in your config, see the Using Shell Scripts guide.
Use Selenium to manage in-browser testing:
version: 2 jobs: build: docker: - image: circleci/node:buster-browsers auth: username: mydockerhub-user password: $DOCKERHUB_PASSWORD # context / project UI env-var reference steps: - checkout - run: mkdir test-reports - run: name: Download Selenium command: curl -O http://selenium-release.storage.googleapis.com/3.5/selenium-server-standalone-3.5.3.jar - run: name: Start Selenium command: java -jar selenium-server-standalone-3.5.3.jar -log test-reports/selenium.log background: true
For more information on browser testing, see the Browser Testing guide.
Use a service container to run database testing:
version: 2 jobs: build: # Primary container image where all commands run docker: - image: circleci/python:3.6.2-stretch-browsers auth: username: mydockerhub-user password: $DOCKERHUB_PASSWORD # context / project UI env-var reference environment: TEST_DATABASE_URL: postgresql://root@localhost/circle_test # Service container image - image: circleci/postgres:9.6.5-alpine-ram auth: username: mydockerhub-user password: $DOCKERHUB_PASSWORD # context / project UI env-var reference steps: - checkout - run: sudo apt-get update - run: sudo apt-get install postgresql-client-9.6 - run: whoami - run: | psql \ -d $TEST_DATABASE_URL \ -c "CREATE TABLE test (name char(25));" - run: | psql \ -d $TEST_DATABASE_URL \ -c "INSERT INTO test VALUES ('John'), ('Joanna'), ('Jennifer');" - run: | psql \ -d $TEST_DATABASE_URL \ -c "SELECT * from test"
For more information on configuring databases, see the Configuring Databases guide.
Run Docker commands to build your Docker images
Run Docker commands to build Docker images. Set up a remote Docker environment when your primary executor is Docker:
version: 2 jobs: build: docker: - image: <primary-container-image> auth: username: mydockerhub-user password: $DOCKERHUB_PASSWORD # context / project UI env-var reference steps: # ... steps for building/testing app ... - setup_remote_docker # sets up remote docker container in which all docker commands will be run - run: name: Start container and verify it's working command: | set -x docker-compose up -d docker run --network container:contacts \ appropriate/curl --retry 10 --retry-delay 1 --retry-connrefused http://localhost:8080/contacts/test
For more information on building Docker images, see the Building Docker Images guide.
Tips for advanced configuration
Here are a few tips for optimization and maintaining a clear configuration file.
- Avoid using large inline bash scripts, especially if used across many jobs. Consider moving large bash scripts into your repo to clean up your config and improve readability.
- Workspaces can be used to copy external scripts between jobs if you don’t want to do a full checkout.
- Move the quickest jobs up to the start of your workflows. For example, lint or syntax checking should happen before longer-running, more computationally expensive jobs.
- Using a “setup” job at the start of a workflow can be helpful to do some preflight checks and populate a workspace for all the following jobs.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.