Skip to main content

How to edit config.yml

Edit config.yml

There are several ways to edit your CircleCI config.yml file:

Using the CircleCI In-App Configuration Editor

CircleCI provides a built-in configuration editor that allows you to modify your configuration files directly in the web app:

  1. In the CircleCI web UI, select a pipeline in the Dashboard's All Pipelines view

  2. Select your desired branch from the "All Branches" drop-down menu

  3. Click the "Edit Config" button to access the configuration editor

The in-app editor offers helpful features like:

  • Automatic validation and error checking

  • Auto-complete suggestions

  • Configuration tooltips

  • Links to relevant documentation

After making changes, you can commit directly to your branch or create a new branch using the "Save and Run" button.

Using VS Code Extension

CircleCI offers a Visual Studio Code extension that provides:

  • Real-time syntax validation

  • Highlighting and autocomplete suggestions

  • Ability to visualize and manage pipelines directly from your code editor

The extension is available on the VS Code marketplace.

Editing Locally

You can also edit the .circleci/config.yml file directly in your local repository:

  1. Create or modify the file in your project's .circleci directory

  2. Validate your configuration using the CircleCI CLI with circleci config validate

  3. Commit and push your changes to trigger a new pipeline

Remember that the config.yml file should be placed in a .circleci directory at the root of your repository. After editing, you can validate your configuration to ensure there are no syntax errors before committing.

Additional Resources

Did this answer your question?