Project—Create or Edit a Project

3 minute readAutomation

Creating a Project

Enter information into the fields as follows:

Field NameDescription

Name

Enter a unique project name. Use a meaningful name such as a work group or product.

To avoid conflicts, do not use CloudBees or any other CloudBees CD/RO-supplied project name. Also, the EC- prefix is reserved for CloudBees CD/RO-supplied project names.

Description

(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

For example, the following HTML:

<p>
<span style="font-family: Arial;">
  <i>Note:</i> For more information about the <b>abc</b> object, see
         <a href="https://www.google.com/">\https://www.google.com</a>.
</span>
</p>

renders as follows:

<i>Note</i>: For more information about the <b>abc</b> object, see \https://www.google.com.

Enable Change Tracking

Disable or enable change tracking for this project. This feature records every change between every state of non-runtime objects and lets you revert to an object’s prior state.

Tracked objects include applications or microservices, procedures, workflows, workspaces, resources, and project-owned components such as library components. For more information, see Change Tracking.

Tags

(Optional) Object tagging provides a way to group related objects with a user-defined term. See Object Tags for further information.

Credentials

(Optional) Credentials and impersonations available to this project. For new projects, you are prompted to create project credentials on a subsequent dialog after project details are entered. See Credentials and User Impersonation for further information.

Select Default Resource

(Optional) Default resource for all jobs that run under the project. This is a convenient way to use a single resource for an entire project.

You can specify resources in several other places such as in procedures and individual job steps. A workspace specified elsewhere takes precedence.

If you have not set up resource names or locations yet, see Configuring Resources for instructions.

Select Default Workspace

(Optional) Default workspace for all jobs that run under the project. This is a convenient way to use a single workspace for an entire project.

There are several other places where you can specify workspaces, such in as procedures and individual job steps. A workspace specified elsewhere takes precedence.

If you have not set up workspace names or locations yet, see Workspaces and Disk Space Management for more information.

Click OK to save your changes.

Your new project name will appear on the Projects page.

You can also create or edit a project via the Projects option on the launch pad in the Deploy web UI:

Editing a Project

Update the information in the fields as needed. See the table in Creating a Project above for field descriptions. If you are editing an existing project, you can make the following additional changes:

Field NameDescription

Tags

(Optional) One or more tags that categorize or mark this project to identify its relationship to one or more other projects or groups. For example, you can tag a group of projects as “production” or “workflow” or use your name so you can quickly filter the project list to see only those projects.

These tags appear in the All Projects drop-down menu on the Projects page. When you select a tag from the drop-down menu, you see only the projects with that tag.

Do not use spaces or symbols. For example, if you want to mark a project with a tag name that represents “Engineering Team A,” enter “eng_team_a.”

If a project is related to several project categories, you can enter a space-separated list to add multiple tags at the same time.

Assigning a tag creates an ec_tag property. You can see this property when you select the Properties subtab from the Project Details page.

Impersonation Credential

Credential (user name and password) to be used by default for all jobs that run under this project. If this field is blank, credential information from other sources is used.

  • Credential Project —Use the current project (the default), or click the other radio button and then click Browse to choose another project.

  • Credential Name —Name of the credential for the project. Enter the name, or click Browse to select one.

For more information, see Credentials and User Impersonation .

Click OK to save your changes.