A Project template can be created from an existing project by selecting which assets to include (code, datasets, apps, etc.). With templates created, users can kickstart their projects from a collection of existing prototypes rather than beginning from scratch. The use of project templates help to enable:
-
Collaboration - Easily share and reuse methods, techniques, and working prototypes with colleagues across the organization or company.
-
Efficiency - Accelerate time to impact by leveraging internal examples as a starting point for your projects.
-
Standardization - Implement internal best practices that can be easily promoted/enforced as company standards.
|
Note
| Project templates are only supported for Git-based projects. |
To create a project template:
-
Navigate to the Project you would like to templatize and click Create Template on the top right. Note that For GitHub and GitHub Enterprise, the button only appears if the code repository for the Project is a template repository.
-
Enter a Template Name, an optional Description, and set the Access level.
-
Select the assets to copy into the template. Also enter a Default Billing Tag (optional), Default Environment, and Default Hardware Tier. Note that Activities, Reviews, Workspaces, Jobs, Experiments and Comments cannot be copied to a template.
-
Choose where to store the code files for the new template, specifying details for the provider, credentials (only PAT credentials are supported), and the repository.
When choosing to store in an existing repository, the repository must be empty. If there is a
README.mdfile in there, it will be overwritten. If there are other files besides that, the operation will fail. Also note that only GitHub, GitHub Enterprise, GitLab, GitLab Enterprise, and Bitbucket Cloud providers are supported.
-
Create the Project template.
|
Note
| For templates stored in GitHub or GitHub Enterprise, the code repository must be marked as a template repository before projects can be created from it. |
To create a Project from a template:
-
Navigate to the Projects page and click on the Templates tab.
-
Browse for the relevant template and click on it to create the project.
-
When creating the project, choose between a number of options for where the code will be stored:
-
New repository: Create a completely new repository for the project code.
-
Existing repository (empty): Use an existing empty repository. The template code files will be copied into the repository. If there is a
README.mdfile in there, it will be overwritten. If there are other files besides that, the operation will fail. -
Existing repository (with code): Use a repository with existing code. Template code files will not be copied into the new repository. Only the project assets will be included.
-
Project templates can be marked with an official flag to indicate an approved or recommended template for usage across the organization.
|
Note
| Only an admin or librarian role can toggle the official flag on a template. Once a template has been flagged as official, practitioner roles can no longer modify or delete the templates. |
To flag a template as official:
-
Navigate to the Projects page and click on the Templates tab.
-
Hover over the relevant template and click on Edit Details.
-
Check the Mark this as an official template box and click Save.
-
Filter the view by Official templates to see all available templates that are marked as official.
| Issue | Workaround |
|---|---|
SysAdmins can’t view Template details | Share the Template with the SysAdmin by adding them as a collaborator |