Projects and Pipelines
This document describes how CircleCI automates your pipelines.
After a software repository on GitHub or Bitbucket is authorized and added as a project to circleci.com, every code change triggers your project’s pipeline. A pipeline represents the entire configuration, including all workflows that are run when you trigger work on your projects that use CircleCI. The entirety of a
.circleci/config.yml file is executed by a pipeline. Jobs run in clean containers or VMs configured to the requirements set out in your configuration file.
A CircleCI project shares the name of the associated code repository in your VCS (GitHub or Bitbucket). Select Projects from the CircleCI application sidebar to enter the Projects dashboard, where you can set up and follow any projects you have access to.
On the Projects Dashboard, you can either:
- Set Up any project that you are the owner of in your VCS
- Follow any project in your organization to gain access to its pipelines and to subscribe to email notifications for the project’s status.
The Project Administrator is the user who adds a GitHub or Bitbucket repository to CircleCI as a Project. A User is an individual user within an org. A CircleCI user is anyone who can log in to the CircleCI platform with a username and password. Users must be added to a GitHub or Bitbucket org to view or follow associated CircleCI projects. Users may not view project data that is stored in environment variables.
If you do not see your project and it is not currently building on CircleCI, check your Organization in the top left corner of the CircleCI application. For example, if the top left shows your user
my-user, only GitHub projects belonging to
my-user will be available under
Add Projects. If you want to build the GitHub project
your-org/project, you must select
your-org on the application Switch Organization menu.
Viewing and navigating pipelines
Your pipeline appears on the Dashboard of the CircleCI app when a new commit is pushed to your repository. You can view workflows or single jobs by expanding the pipeline and clicking in on any workflow or job descriptors.
When viewing a single job in a pipeline, you can use the breadcrumbs at the top of the page to navigate back to a job’s respective workflow or pipeline.
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.