debian-mirror-gitlab/doc/gitlab-basics/create-project.md

171 lines
7.8 KiB
Markdown
Raw Normal View History

2019-10-12 21:52:04 +05:30
---
type: howto
---
2015-09-11 14:41:01 +05:30
2019-12-04 20:38:33 +05:30
# Create a project
2018-03-17 18:26:18 +05:30
2019-10-12 21:52:04 +05:30
Most work in GitLab is done within a [Project](../user/project/index.md). Files and
code are saved in projects, and most features are used within the scope of projects.
## Create a project in GitLab
2015-09-11 14:41:01 +05:30
2019-03-02 22:35:43 +05:30
To create a project in GitLab:
2015-09-11 14:41:01 +05:30
2019-03-02 22:35:43 +05:30
1. In your dashboard, click the green **New project** button or use the plus
icon in the navigation bar. This opens the **New project** page.
1. On the **New project** page, choose if you want to:
- Create a [blank project](#blank-projects).
- Create a project using with one of the available [project templates](#project-templates).
- [Import a project](../user/project/import/index.md) from a different repository,
2019-10-12 21:52:04 +05:30
if enabled on your GitLab instance. Contact your GitLab admin if this is unavailable.
2019-09-30 21:07:59 +05:30
- Run [CI/CD pipelines for external repositories](../ci/ci_cd_for_external_repos/index.md). **(PREMIUM)**
2015-09-11 14:41:01 +05:30
2019-10-12 21:52:04 +05:30
NOTE: **Note:**
For a list of words that cannot be used as project names see
[Reserved project and group names](../user/reserved_names.md).
### Blank projects
2015-09-11 14:41:01 +05:30
2019-03-02 22:35:43 +05:30
To create a new blank project on the **New project** page:
2017-09-10 17:25:29 +05:30
2019-03-02 22:35:43 +05:30
1. On the **Blank project** tab, provide the following information:
2019-09-30 21:07:59 +05:30
- The name of your project in the **Project name** field. You can't use
special characters, but you can use spaces, hyphens, underscores or even
2020-03-13 15:44:24 +05:30
emoji. When adding the name, the **Project slug** will auto populate.
The slug is what the GitLab instance will use as the URL path to the project.
If you want a different slug, input the project name first,
then change the slug after.
- The path to your project in the **Project slug** field. This is the URL
path for your project that the GitLab instance will use. If the
**Project name** is blank, it will auto populate when you fill in
the **Project slug**.
2019-09-30 21:07:59 +05:30
- The **Project description (optional)** field enables you to enter a
description for your project's dashboard, which will help others
understand what your project is about. Though it's not required, it's a good
idea to fill this in.
- Changing the **Visibility Level** modifies the project's
[viewing and access rights](../public_access/public_access.md) for users.
- Selecting the **Initialize repository with a README** option creates a
README file so that the Git repository is initialized, has a default branch, and
can be cloned.
2017-08-17 22:00:37 +05:30
1. Click **Create project**.
2019-10-12 21:52:04 +05:30
### Project templates
2019-03-02 22:35:43 +05:30
2019-10-12 21:52:04 +05:30
Project templates can pre-populate a new project with the necessary files to get you
started quickly.
2019-03-02 22:35:43 +05:30
There are two types of project templates:
2019-07-07 11:18:12 +05:30
- [Built-in templates](#built-in-templates), sourced from the following groups:
- [`project-templates`](https://gitlab.com/gitlab-org/project-templates)
- [`pages`](https://gitlab.com/pages)
2019-10-12 21:52:04 +05:30
- [Custom project templates](#custom-project-templates-premium), for custom templates
configured by GitLab administrators and users.
2019-03-02 22:35:43 +05:30
2019-10-12 21:52:04 +05:30
#### Built-in templates
2019-03-02 22:35:43 +05:30
Built-in templates are project templates that are:
2019-10-12 21:52:04 +05:30
- Developed and maintained in the [`project-templates`](https://gitlab.com/gitlab-org/project-templates)
and [`pages`](https://gitlab.com/pages) groups.
2019-03-02 22:35:43 +05:30
- Released with GitLab.
To use a built-in template on the **New project** page:
2019-07-31 22:56:46 +05:30
1. On the **Create from template** tab, select the **Built-in** tab.
2019-03-02 22:35:43 +05:30
1. From the list of available built-in templates, click the:
2019-09-30 21:07:59 +05:30
- **Preview** button to look at the template source itself.
- **Use template** button to start creating the project.
2019-10-12 21:52:04 +05:30
1. Finish creating the project by filling out the project's details. The process is
the same as creating a [blank project](#blank-projects).
2019-03-02 22:35:43 +05:30
2020-04-22 19:07:51 +05:30
##### Enterprise templates **(ULTIMATE)**
GitLab is developing Enterprise templates to help you streamline audit management with selected regulatory standards. These templates automatically import issues that correspond to each regulatory requirement.
To create a new project with an Enterprise template, on the **New project** page:
1. On the **Create from template** tab, select the **Built-in** tab.
1. From the list of available built-in Enterprise templates, click the:
- **Preview** button to look at the template source itself.
- **Use template** button to start creating the project.
1. Finish creating the project by filling out the project's details. The process is the same as creating a [blank project](#blank-projects).
Available Enterprise templates include:
- HIPAA Audit Protocol template ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13756) in GitLab 12.10)
2019-03-02 22:35:43 +05:30
TIP: **Tip:**
2019-10-12 21:52:04 +05:30
You can improve the existing built-in templates or contribute new ones in the
[`project-templates`](https://gitlab.com/gitlab-org/project-templates) and
2020-04-22 19:07:51 +05:30
[`pages`](https://gitlab.com/pages) groups by following [these steps](https://gitlab.com/gitlab-org/project-templates/contributing).
2019-03-02 22:35:43 +05:30
2019-10-12 21:52:04 +05:30
#### Custom project templates **(PREMIUM)**
2019-03-02 22:35:43 +05:30
2020-04-22 19:07:51 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/6860) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2.
2019-03-02 22:35:43 +05:30
2019-12-21 20:55:43 +05:30
Creating new projects based on custom project templates is a convenient option for
quickly starting projects.
2019-03-02 22:35:43 +05:30
2019-10-12 21:52:04 +05:30
Custom projects are available at the [instance-level](../user/admin_area/custom_project_templates.md)
from the **Instance** tab, or at the [group-level](../user/group/custom_project_templates.md)
from the **Group** tab, under the **Create from template** tab.
2019-03-02 22:35:43 +05:30
To use a custom project template on the **New project** page:
1. On the **Create from template** tab, select the **Instance** tab or the **Group** tab.
1. From the list of available custom templates, click the:
2019-09-30 21:07:59 +05:30
- **Preview** button to look at the template source itself.
- **Use template** button to start creating the project.
2019-10-12 21:52:04 +05:30
1. Finish creating the project by filling out the project's details. The process is
the same as creating a [blank project](#blank-projects).
2019-03-02 22:35:43 +05:30
2018-03-17 18:26:18 +05:30
## Push to create a new project
2019-12-04 20:38:33 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/26388) in GitLab 10.5.
2018-03-17 18:26:18 +05:30
2019-10-12 21:52:04 +05:30
When you create a new repository locally, instead of going to GitLab to manually
create a new project and then [clone the repo](start-using-git.md#clone-a-repository)
locally, you can directly push it to GitLab to create the new project, all without leaving
your terminal. If you have access rights to the associated namespace, GitLab will
automatically create a new project under that GitLab namespace with its visibility
set to Private by default (you can later change it in the [project's settings](../public_access/public_access.md#how-to-change-project-visibility)).
2018-03-17 18:26:18 +05:30
2019-03-02 22:35:43 +05:30
This can be done by using either SSH or HTTPS:
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
```shell
2018-03-17 18:26:18 +05:30
## Git push using SSH
2018-03-27 19:54:05 +05:30
git push --set-upstream git@gitlab.example.com:namespace/nonexistent-project.git master
2018-03-17 18:26:18 +05:30
2019-03-02 22:35:43 +05:30
## Git push using HTTPS
2018-03-27 19:54:05 +05:30
git push --set-upstream https://gitlab.example.com/namespace/nonexistent-project.git master
2018-03-17 18:26:18 +05:30
```
Once the push finishes successfully, a remote message will indicate
the command to set the remote and the URL to the new project:
2019-03-02 22:35:43 +05:30
```text
2018-03-17 18:26:18 +05:30
remote:
remote: The private project namespace/nonexistent-project was created.
remote:
remote: To configure the remote, run:
remote: git remote add origin https://gitlab.example.com/namespace/nonexistent-project.git
remote:
remote: To view the project, visit:
remote: https://gitlab.example.com/namespace/nonexistent-project
remote:
```
2019-10-12 21:52:04 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->