Quickstart guide
This quickstart provides a guided tour through setting up a project, collaborating, and tools to iterate on and debug your build configuration. The following sections cover the following:
Create a project, connecting some existing code to CircleCI.
Inviting team members to collaborate on your new project.
Use the VS Code extension to debug and extend your config.
SSH into a build to debug your project.
If you would rather jump to a full list of CircleCIconfig.yml options, see the Configuration reference.
Prerequisites
A CircleCI account. You can sign up for free.
A code repository you want to build on CircleCI.
1. Connect your code
Check your project slug to discover which GitHub integration you have set up:
For more information about the differences, see the VCS integration overview. |
In the CircleCI web app select your org, then selectCreate Project, then follow the instructions in the app. Don’t see these options? Select the CircleCI logo in the top bar to get back to your user homepage and check you have the correct org selected.
Follow the in-app instructions to set up your pipelinem including connecting your code, preparing a config file and reviewing triggers. For a more detailed look at this process see the Create a project guide.
Once you have gone through the pipeline setup process in the app you have everything you need to commit your config (unless you have a config in your repo already) and build. Review your project details and selectCommit config and run.
You should soon have a passing pipeline. In the next sections we will cover ways to modify and debug your config.
config.yml file. You can swap out this config for an alternative by clickingChange: Hello World.
.circleci/config.yml file at the root of your repository on a new branch calledupdate-circleci-config.
In the CircleCI web app select your org, then selectSet up a Project, then selectSet up Project next to your project in the list. Don’t see these options? Select the CircleCI logo in the top bar to get back to your user homepage and check you have the correct org selected.
In the “Select your config.yml file” modal, selectFaster, then clickSet Up Project.
You should soon have a passing pipeline. In the next sections we will cover ways to modify and debug your config.
2. Dig into your first pipeline
Expand your workflow and select a job to view the steps that ran. Use the tabs along the top to access test results, timing data, artifacts, and resource usage metrics.
Exand any step to view the build output. You can search, share or download the output for collaboration and debugging. If a step fails, use the Explain this error button for help.
Invite teammates to collaborate on your projects. Navigate toOrganization Settings > People to generate invites and get further instructions. Collaborators can view and follow your projects. Teammates can make a free CircleCI account at any time to view your pipelines, even if they are not committing any code.
3. Debug and iterate
To access a job's build environment for troubleshooting, rerun the job with SSH access. The VM remains active for 10 minutes after the pipeline finishes. For full details, see the Debug with SSH page.
Using the CircleCI VS Code extention, validate your CircleCI config file. Get help with troubleshooting config updates and help keeping dependencies up to date.
