Managing a Project

After creating a project, you can manage it from the Project Settings page.

You can change a project’s properties such as its name, description, security level, and the wiki markup language.

Editing Project Properties

After creating a project, you can edit a project's properties from the Project Settings page.

To edit project properties:

1. In the navigation bar, click Project Settings.
2. Click Properties.
3. In the Properties page, complete the elements using the descriptions in the table.

   • In Name and Description, update the project name and description.

   • In Security, update the project’s share status.

   • In Preferred Language, specify the preferred language for your email notifications.

     To configure email notifications, see Setting Email Notifications.

   • In Markup Language, update the project’s wiki markup language.

   • In Template, define settings to make the project a project template.

When you’re finished, use the project navigation bar to switch to another page.

Deleting a Project

You can delete a project from the Project Settings: Properties page.

To delete a project:

1. Open the project.
2. In the navigation bar, click Project Settings.
3. Click Properties.
4. In the Properties page, click Delete Project.
5. In the Delete Project dialog, select the I understand that my project will be permanently deleted check box.
6. Click Delete.

Changing the Wiki Markup Language of a Project

Oracle Developer Cloud Service supports wiki markup languages for document authoring, collaboration, and formatting comments. The wiki markup language is specified in the New Project wizard and in the Properties page of the Project Settings page.

The project uses the specified wiki markup language at the following places:

• Wiki pages in the Wiki page

• Comments field of an issue in the Issues page

• Comments field in the Conversation tab of the Merge Request page

• Comments field in the Add Comment dialog of the source code while a merge request is in progress.

• Comments field in the Approve Merge Request dialog, Reject Merge Request dialog, and Merge dialog of the Merge Request

To change the wiki markup language of the project:

1. In the navigation bar, click Project Settings.
2. Click Properties.
3. In the Properties page, select the Wiki markup language from the Markup Language options.

Note:

The changed wiki markup language will be used by new wiki pages and new comments in the Issues and Merge Request pages. Existing wiki pages and comments will continue to use the old wiki markup language.

Configuring the Project as a Project Template

You can define an existing project to be used as a template for new projects. When specified, the project's name appears in the Template list in the Template page of the New Project wizard.

From the Project Settings: Properties page, you can define and change the properties of the template project. While defining a template, you use variables and rules. Variables define data to be accepted and used when the new project is created. Rules define the information or artifacts to be copied from the template project to the new project.

About Project Templates

A project template is a project that can be used as a starting point by users when they create a project. While creating a project, if you choose a template, its data is copied to the new project.

Project template data may include its Git repositories, build job configurations, deployment configurations, links, wikis, and announcements.

For example, if a project template hosts a sample application in its Git repositories; information on how to use the application in its wiki pages; build configuration in its jobs; and Oracle Cloud deployment target details in its deployment configurations, then the data of the project template is copied to the new project. Project users can review or update the sample application, run builds of pre-configured jobs, and deploy build artifacts to Oracle Cloud using pre-configured deployment configurations.

When you define a project template, you define its visibility (who can use the project template), configure rules (what data can be copied from the project template), and use variables (customize actions based on user input).

After a project is created using a template, any updates made to the template project are not reflected in the created project.

The following table lists artifacts that can be copied from the project template to the new project:

Artifact	Copied to the New Project
Git Repositories	Yes External repositories of the project are not copied by default. To copy them to the new project, add an additional rule. See Adding or Editing an External Git Repository Rule.
Maven repository and artifacts	No
Environments	No
Releases	No
Snippets	No
Merge Requests	No
Issues	No
Agile boards	No
Build jobs	Yes User credentials used in the job configuration are not copied.
Deployment configurations	Yes
Linked Docker registries	No
Wiki pages	Yes
Announcements	Yes
Links	Yes
Tags	No
Webhooks	No
RSS/Atom Feeds	No

Project Template’s Visibility

A project template’s visibility can be in one of the following states: Draft, Private, or Shared.

• Draft

  The project template is under design and is not available in the Templates page of the Create Project wizard.

• Private

  The project template is available to organization users, but is not visible by name. It can be accessed through its private key only.

  It is visible by name to all members of the project template.

• Shared

  The project template is a shared template and is available to all users of the organization.

About Project Template Rules

Using project template’s rules, you define what data is copied to the new project. When you define a project as a project template, all rules are enabled by default.

Some rules can't be edited and some rules can’t be added more than once. The following table lists rules available in a project template:

Rule	Description	Edit?	Add more than once?
Build Jobs	Copies all build jobs of the project template to the new project.	No	No
Wiki Content	Copies all wiki pages of the project template to the new project.	No	No
Links	Copies all link rules of the project template to the new project.	No	No
Git Repository	Copies the specified Git repository along with its branches to the new project.	Yes	Yes
External Git Repository	Copies the specified external Git repository along with its branches to the new project.	Yes	Yes
Deployments	Copies all deployment configurations of the project template to the new project.	No	No
Announcements	Copies all announcements of the project template to the new project.	No	No

As described in the above table, Git repository rules can be added more than once, while other rules can be added only once. You can add a Git repository rule for each repository and edit the rule to change the default behavior of copying Git repository files to the new project.

Project Template Variables

Using variables in a project template, you can get user input in the Create Project wizard. Based on the input, you can change the behavior or properties of data copied to the new project.

Variables, if defined, are available in the Properties page of the Create Project wizard. You can also use them while configuring Git repository rules.

The following types of variables are available.

• Boolean

  Accepts a True-False (or Yes-No) value.

• Choice

  Accepts a value from a list of values.

• String

  Accepts a string value.

• URL

  Accepts a valid URL value.

Defining a Project Template

You can specify an existing project to be used as a template from the Administration: Properties page

To define an existing project as a project template:

1. In the navigation bar, click Administration.
2. Click Properties.
3. In the Template section, click Define Template.
   The project is now defined to be used as a template with the default rules and properties.
4. To edit rules and properties, click Edit.
5. On the Template page, update properties, and define rules, as desired.
6. Click Save.

Defining a Private Project Template

Private project templates are not listed by name in the Templates page of the New Project wizard, unless you are a member of the project template. Non-members can use a private project template only if they have the private key of the project template.

You may want to create a private project template if you do not want all users of the organization to copy data from the project.

To define an existing project as a private project template:

1. In the navigation bar, click Administration.
2. Click Properties.
3. In the Template section, click Define Template.
   The project is now defined to be used as a template with the default rules and properties.
4. Click Edit.
5. On the Template page, in the Visibility section, select Private.
6. For the Private Key field, click Show. Note down the key value.
7. Update settings, add variables, and define rules, as desired.
8. Click Save.

Share the private key value with users who can use the project template and copy the project data.

To generate a new private key, edit the project template, click Show, and then click Regenerate. You may want to do this if you do not want users who already have the old key value to copy the project data from the template.

Defining a Project Template with an External Git Repository

You can define a project template with external Git repositories, such as GitHub or BitBucket. In the Create Project wizard, when the project template is selected, the external Git repositories are also copied to the new project.

To do that, you must add an External Git Repository rule and configure it to access the external Git repository.

To define a project template with an external Git repository:

1. In the project, add external Git repositories.
   See Adding an External Git Repository.
2. In the navigation bar, click Administration.
3. Click Properties.
4. In the Template section, click Define Template.
5. Click Edit.
6. On the Template page, update settings, add variables, and define rules, as desired.
7. Add an External Git Repository rule. See Adding or Editing an External Git Repository Rule.
8. Click Save to save the template.

Editing Project Template’s General Settings

To update a project template’s general settings:

1. In the navigation bar, click Administration.
2. Click Properties.
3. In the Template section, click Edit.
4. In the Template Settings section, update the values of Visibility, Title, Description, and Icon fields, as necessary.
   To know more about what to fill in the fields, open the help page. On the branding bar, click Help , and select Help for This Page..
5. Click Save.

Using Project Template Rules

You can add, edit, and remove rules of a template. Only Git repository rules can be edited and added more than once. Other rules can’t be edited or added more than once.

Adding a Rule

1. In the navigation bar, click Administration.

2. Click Properties.

3. In the Template section, click Edit.

4. In the Rules section, click Add Rule. From the menu, select the rule.

Deleting a Rule

1. In the navigation bar, click Administration.

2. Click Properties.

3. In the Template section, click Edit.

4. In the Rules section, to the right of the rule you want to remove, click Remove .

Adding or Editing a Git Repository Rule

You can edit a Git Repository rule and add it more than once. You can add the rule for each repository of the project.

To edit a Git Repository rule:

1. In the navigation bar, click Administration.
2. Click Properties.
3. In the Template section, click Define Template.
4. To edit rules and properties, click Edit.
5. To edit the rule, to the right side of the Git repository Rule, click Edit .
   To add the rule, click Add Rule. From the menu, select Git Repository.
6. In Source Repository, specify the name of the Git repository to be copied.
7. In Repository Name, specify the new name of the Git repository. A .git extension is automatically added if you missed it.
   To use the new project name as the name of the Git repository, select the Use target project name check box.
8. In Replacements, define file name replacements of the Git repository matching the specified criterion.

   In: From the drop-down list, select files where the replacements should be applied.

   • All Files: Apply the replacement to all files of the Git repository

   • Files Matching: Apply the replacement to files matching the specified pattern. In ant file pattern, specify the pattern and click Save .

   • Single File: Apply the replacement to specified files matching the specified name. In file name, specify the name and click Save .

   Replace: Specify the search term.

   With: From the drop-down list, select the replacement term.

   • Project Id: Replaces the specified term with the project ID

   • Project Name: Replaces the specified term with the project name

   • Project URL Name: Replaces the specified term with the project URL

   • Repository Name: Replaces the specified term with the value of the Repository Name field

   • Variable: Replaces the specified term with the value of the specified variable

   Click Save to save the replacements rule.

9. Click Save to save the Git repository rule.
10. Click Save to save the project template.

Adding or Editing an External Git Repository Rule

You can edit an external Git Repository rule and add it more than once.

To edit an external Git repository rule:

1. In the navigation bar, click Administration.
2. Click Properties.
3. In the Template section, click Define Template.
4. Click Edit.
5. To edit the rule, to the right side of the External Git Repository rule, click Edit .
   To add an External Git Repository rule, click Add Rule. From the menu, select External Git Repository.
6. In Repository URL, enter the external Git repository URL. To update, enter a new URL.
7. In Username and Password, enter credentials to access the external Git repository.
   For public Git repositories, do not fill these fields.
8. In Repository Name, specify the new name of the Git repository. A .git extension is automatically added if you missed it.
   To use the new project name as the name of the Git repository, select the Use target project name check box.
9. Click Save to save the rule.
10. Click Save to save the project template.

Using Variables

You can add or edit variables from the Variables section on the Template page.

Adding a Variable

1. In the navigation bar, click Administration.

2. Click Properties.

3. In the Template section, click Edit.

4. In the Variable section, click Add Variable. From the menu, select the variable type.

5. Fill in the fields of the variable and click Save.

Editing a Variable

1. In the navigation bar, click Administration.

2. Click Properties.

3. In the Template section, click Edit.

4. In the Variable section, click Edit .

5. Update the fields of the variable and click Save.

Deleting a Variable

1. In the navigation bar, click Administration.

2. Click Properties.

3. In the Template section, click Edit.

4. In the Variable section, to the right of the variable you want to remove, click Remove .

Deleting a Project Template

Deleting a project template removes the template’s definition that includes its settings, rules, and variables. The project data is not deleted.

To delete a project template:

1. In the navigation bar, click Administration.
2. Click Properties.
3. In the Template section, click Delete Template.
4. In the Delete Template Definition dialog box, click Delete Template.