Creating and Editing Projects
This section details creating projects via the TeamCity web UI. Other options include the REST API and using TeamCity project configuration in DSL based on the Kotlin language.
Creating Project
To create a project, use the Administration link in the upper right corner and click Create project. The Create project page is displayed.
There are several options to create a project from:
Note that only two options are available by default: From a repository URL and Manually. If a connection to some VCS hosting service is configured in the Root project (or a parent project of the project to be created), the corresponding option becomes available, so you can create a project using an existing VCS connection specification.
To create a subproject, go to the Project Settings page of the parent project and use one of the available options, similarly to creating a project.
Creating project pointing to repository URL
1\. On the Create project page, click the "From a repository URL" tile.
2\. Specify the project settings:
Setting | Description |
|---|---|
Parent Project | Select the parent project from the drop-down menu. |
Repository URL | A VCS repository URL. TeamCity recognizes URLs for Subversion, Git, and Mercurial. TFS and Perforce are partially supported. Icons next to this field represent VCS hosting services supported by TeamCity. If you click an active (highlighted) icon, you will be able to select an existing connection specification. If you click an inactive icon, you will be redirected to the Add Connection form. Depending on the URL format, the following authentication settings may vary. |
Authentication | TeamCity automatically sets this field to either "Password / Access token" or "SSH key" depending on the URL format. |
Username | Available if the Authentication is set to "Password / Access token". Specifies a username required to access the repository. Can be left empty if you want to access a public repository that allows anonymous access. |
Password | Available if the Authentication is set to "Password / Access token". Specifies a password or token required to access the repository. Can be left empty if you want to access a public repository that allows anonymous access. |
SSH key | Available if the Authentication is set to "SSH key". Allows you to upload a new private SSH key or choose a previously uploaded key. |
SSH passphrase | Available if the Authentication is set to "SSH key". Allows you to specify a passphrase for encrypted SSH keys. |
3\. Click Proceed. TeamCity will configure the rest of settings for you.
it will determine the type of the VCS repository, autoconfigure VCS repository settings, and suggest the project and build configuration names.
For a Git repository, TeamCity will autodetect the default branch, but you have an option to change it and to add other branches to monitor by entering their specification.
the project, build configuration and VCS root will be created automatically.
TeamCity will add a VCS build trigger.
TeamCity will attempt to autodetect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects.
4\. On the Auto-detected Build Steps page select the detected step(s) to use in your build configuration. Click Use selected. If no steps found, you will have to configure build steps manually.
5\. Your project and a build configuration are configured. Click the Run button to start the build.
Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review Suggestions at the end of the settings list and configure required ones.
Creating project pointing to GitHub.com repository
On the Create project page, click a "From GitHub" tile to create a project from an existing connection
Select a repository. TeamCity will verify the repository connection. If the connection is verified, the new page opens.
TeamCity will display the project and build configuration name. If required, modify the names and click Proceed. TeamCity will autodetect the default Git branch, but you have an option to change it and to add other branches to monitor by entering their specification.
TeamCity will add a VCS build trigger and attempt to autodetect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects.
On the Auto-detected Build Steps page, select the detected step(s) to use in your build configuration. Click Use selected.
If no steps found, you will have to configure build steps manually.
Your project and a build configuration are configured. Click Run to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review Suggestions at the end of the settings list and configure required ones.
Creating project pointing to Bitbucket
On the Create project page, click a corresponding "From Bitbucket" tile to create a project from an existing connection to Bitbucket Cloud, Server, or Data Center. See this help article to learn how to set up new connections: Bitbucket Cloud | Bitbucket Server and Data Center.
Select a repository. TeamCity will verify the repository connection. If the connection is verified, the new page opens.
TeamCity will display the project and build configuration name. If required, modify the names and click Proceed. For a Git repository, TeamCity will autodetect the default branch, but you have an option to change it and to add other branches to monitor by entering their specification.
TeamCity will add a VCS build trigger and attempt to autodetect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects.
On the Auto-detected Build Steps page, select the detected step(s) to use in your build configuration. Click Use selected.
If no steps found, you will have to configure build steps manually.
Your project and a build configuration are configured. Click Run to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review Suggestions at the end of the settings list and configure required ones.
Creating project pointing to GitLab.com
On the Create project page, click a "From GitLab" tile to create a project from an existing connection.
Select a repository. TeamCity will verify the repository connection. If the connection is verified, the new page opens.
TeamCity will display the project and build configuration name. If required, modify the names and click Proceed. TeamCity will autodetect the default Git branch, but you have an option to change it and to add other branches to monitor by entering their specification.
TeamCity will add a VCS build trigger and attempt to autodetect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects.
On the Auto-detected Build Steps page, select the detected step(s) to use in your build configuration. Click Use selected.
If no steps found, you will have to configure build steps manually.
Your project and a build configuration are configured. Click Run to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review Suggestions at the end of the settings list and configure required ones.
Creating project pointing to Azure DevOps Services
On the Create project page, click a "From Azure DevOps" tile to create a project from an existing connection. The recommended approach for Git repositories is to use the connection based on OAuth 2.0 protocol. If you need to connect to a TFVC repository, use the obsolete PAT-based connection.
Select a repository. TeamCity will verify the repository connection. If the connection is verified, the new page opens.
TeamCity will display the project and build configuration name. If required, modify the names and click Proceed. For a Git repository, TeamCity will autodetect the default branch, but you have an option to change it and to add other branches to monitor by entering their specification.
TeamCity will add a VCS build trigger and attempt to autodetect build steps.
On the Auto\-detected Build Steps page select the detected step(s) to use in your build configuration. Click Use selected.
If no steps found, you will have to configure build steps manually.
Your project and a build configuration are configured. Click Run to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review Suggestions at the end of the settings list and configure required ones.
Creating project pointing to JetBrains Space
Before creating a project from a JetBrains Space, you need to configure a dedicated connection to your Space instance.
On the Create project page, click a "From JetBrains Space" tile to create a project from an existing connection. The first time, you will be prompted to sign in to Space and grant TeamCity access to view your user profile and projects. To be able to do this, TeamCity will create a service token for authenticating in your Space instance.
Select a repository. TeamCity will verify the repository connection. If the connection is verified, the new page opens.
TeamCity will display the project and build configuration names. If required, modify them and click Proceed. For a Git repository, TeamCity will autodetect the default branch, but you have an option to change it and to add other branches to monitor by entering their specification.
TeamCity will add a VCS build trigger and attempt to autodetect build steps.
On the Auto\-detected Build Steps page select the detected step(s) to use in your build configuration. Click Use selected.
If no steps found, you will have to configure build steps manually.
Your project and a build configuration are configured. Click Run to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review Suggestions at the end of the settings list and configure required ones.
Creating project manually
1\. Click the Create project button and select Manually.
2\. On the Create New Project page, specify the project settings:
Setting | Description |
|---|---|
Parent Project | Select the parent project from the drop-down menu. |
Name | The project name. |
Project ID | ID of the project |
Description | Optional description for the project. You can add a link in the Markdown format to the description:
[My Project](https://www.example.com)
|
3\. Click Create. An empty project is created.
4\. Create build configurations (select build settings, configure VCS settings, and choose build runners) for the project.
Managing Project
You can view all available projects and subprojects on the Projects page listed in the alphabetical order by default. Administrators can customize the default order.
When you select a project from the list, TeamCity displays the Project Home page where you can preview its nested build configurations and recent build results. To access the project's settings, click Edit Project Settings in the upper right corner of the screen.
To copy, move, delete or archive a project, use the Actions menu in the upper right corner of the Project Settings page or the More button 
next to the project on the parent Project Settings page. These options are not available for the Root project.
Copying Project
Use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button next to the project on the parent Project Settings page.
Projects can be copied and moved to another project by project administrators.
A copy duplicates all the settings, subprojects, build configurations, and templates of the original project, but no data related to builds is preserved. The copy is created with the empty build history and no statistics.
You can copy a project into the same or another parent.
On copying, TeamCity automatically assigns a new name and ID to the copy. It is also possible to change the name and ID manually.
Selecting the Copy project-associated user, agent and other settings option makes sure that all the settings like notification rules or agent's compatibility are exactly the same for the copied and original projects for all the users and agents affected.
You can also opt to copy build configurations build numbers.
Moving Project
To move a project, use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button next to the project on the parent Project Settings page.
When moving a project, TeamCity preserves all its settings, subprojects, build configurations/templates, and associated data, as well as the build history.
Archiving Project
Use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button next to the project on the parent Project Settings page. Refer to the dedicated page.
Bulk Editing IDs
Use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button
next to the project on the parent Project Settings page.The current project and build configuration IDs are displayed. You can modify or reset the IDs for all subproject, VCS roots, build configurations and templates. Click Regenerate to get new Ids automatically or edit them manually.
Click Submit.
Pausing / Activating Triggers
You can pause triggers for all or selected build configurations of a project. Use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button next to the project on the parent Project Settings page.
Exporting Project
You can export configuration files of a project with its children to move it to a different TeamCity server. Use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button next to the project on the parent Project Settings page.
Deleting Project
Use the corresponding item from the Actions menu in the upper right corner of the Project Settings page or the More button next to the project on the parent Project Settings page.
When you delete a project, TeamCity will remove its .xml configuration files. After the deletion, the project is moved to the \< TeamCity Data Directory \>/config/_trash/.ProjectID.projectN directory. There is a configurable timeout (5 days by default) before all project-related data stored in the database (build history, artifacts, and so on) of the deleted project is completely removed during the next build history clean-up.
The \< TeamCity Data Directory \>/config/_trash/ directory is not cleaned automatically and can be emptied manually if you are sure you do not need the deleted projects.