Usage in Config

Use The CircleCI Config SDK To Run Your Pipeline

Config Applications

Using the CircleCI Config SDK, we can write a "config app" in JavaScript or TypeScript, rather than putting our config logic in a config.yml file.

Dynamic Config Method

The suggested method for using the Config SDK.

This method builds your config app via CircleCI's Dynamic Config at the time your pipeline begins. This gives your config app access to build run-time environment variables, git data, and benefit from just-in-time config compilation

How to write a dynamic config app

Go a step further and publish your own NPM module using the Config SDK and manage all of your repositories' CI configs from one centrally managed, semantically versioned location.

Write a config package

Static Config Method

Generate a CircleCI config locally and automatically with git pre-commit hooks. CircleCI's Dynamic Config is not required. However, statically generated configs are generated locally and do not benefit from just-in-time compilation.

How to write a static config app

---

Examples and Tutorials

• How to use Orbs in the CircleCI Config SDK