Manage projects
DETAILS: Tier: Free, Premium, Ultimate Offering: SaaS, self-managed
Most work in GitLab is done in a project. Files and code are saved in projects, and most features are in the scope of projects.
View all projects for the instance
To view all projects for the GitLab instance:
- On the left sidebar, select Search or go to.
- Select Explore.
On the left sidebar, Projects is selected. On the right, the list shows all projects for the instance.
If you are not authenticated, then the list shows public projects only.
View projects you are a member of
To view projects you are a member of:
- On the left sidebar, select Search or go to.
- Select Your work.
On the left sidebar, Projects is selected. On the list, on the Yours tab, all the projects you are a member of are displayed.
View personal projects
Personal projects are projects created under your personal namespace.
For example, if you create an account with the username alex
, and create a project
called my-project
under your username, the project is created at https://gitlab.example.com/alex/my-project
.
To view your personal projects:
- On the left sidebar, select your avatar and then your username.
- On the left sidebar, select Personal projects.
View starred projects
To view projects you have starred:
- On the left sidebar, select your avatar and then your username.
- On the left sidebar, select Starred projects.
Edit project name and description
Use the project general settings to edit your project details.
Prerequisites:
- You must have at least the Maintainer role for the project.
- On the left sidebar, select Search or go to and find your project.
- Select Settings > General.
- In the Project name text box, enter your project name. See the limitations on project names.
- In the Project description text box, enter your project description. The description is limited to 2,000 characters.
- Under Project avatar, to change your project avatar, select Choose file.
Star a project
You can add a star to projects you use frequently to make them easier to find.
To add a star to a project:
- On the left sidebar, select Search or go to and find your project.
- In the upper-right corner of the page, select Star.
Delete a project
- Default deletion behavior for projects changed to delayed project deletion in GitLab 12.6.
- Default deletion behavior for projects changed to immediate deletion in GitLab 13.2.
- Default deletion behavior for projects on the Premium and Ultimate tier changed to delayed project deletion in GitLab 16.0.
- Default deletion behavior changed to delayed deletion on the Premium and Ultimate tier on GitLab.com and on self-managed in GitLab 16.0.
You can mark a project to be deleted. After you delete a project:
- Projects in personal namespaces are deleted immediately.
- Projects in groups are deleted after a retention period.
Prerequisites:
- You must have the Owner role for a project.
To delete a project:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > General.
- Expand Advanced.
- In the Delete this project section, select Delete project.
- On the confirmation dialog, enter the project name and select Yes, delete project.
This action deletes the project and all associated resources (such as issues and merge requests).
You can also delete projects using the Rails console.
Delayed project deletion
DETAILS: Tier: Premium, Ultimate Offering: SaaS, self-managed
- Enabled for projects in personal namespaces in GitLab 15.1.
- Disabled for projects in personal namespaces in GitLab 15.3.
- Enabled delayed deletion by default and removed the option to delete immediately on GitLab.com and on self-managed in GitLab 16.0.
Prerequisites:
- You must have the Owner role for the project.
Projects in a group (not a personal namespace) can be deleted after a delay period.
On self-managed instances, group administrators can define a deletion delay period of between 1 and 90 days. On SaaS, there is a non-adjustable default retention period of seven days.
You can view projects that are pending deletion, and use the Rails console to find projects that are pending deletion.
Delete a project immediately
DETAILS: Tier: Premium, Ultimate Offering: SaaS, self-managed
- Introduced in GitLab 14.1.
- Option to delete projects immediately from the Admin Area and as a group setting removed on GitLab.com and on self-managed in GitLab 16.0.
Prerequisites:
- You must have the Owner role for the project.
- The project must be marked for deletion.
If you don't want to wait for delayed deletion, you can delete a project immediately. To do this, perform the steps for deleting a projects again.
In the first cycle of deleting a project, the project is moved to the delayed deletion queue and automatically deleted after the retention period has passed. If during this delayed deletion time you run a second deletion cycle, the project is deleted immediately.
To immediately delete a project marked for deletion:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > General.
- Expand Advanced.
- In the Delete this project section, select Delete project.
- On the confirmation dialog, enter the project name and select Yes, delete project.
View projects pending deletion
DETAILS: Tier: Premium, Ultimate Offering: SaaS, self-managed
- Introduced in GitLab 13.3 for Administrators.
- Tab renamed from Deleted projects in GitLab 14.6.
- Available to all users in GitLab 14.8 with a flag named
project_owners_list_project_pending_deletion
. Enabled by default.- Generally available in GitLab 14.9. Feature flag
project_owners_list_project_pending_deletion
removed.
To view a list of all projects that are pending deletion:
- On the left sidebar, select Search or go to.
- Select View all my projects.
- Based on your GitLab version:
- GitLab 14.6 and later: select the Pending deletion tab.
- GitLab 14.5 and earlier: select the Deleted projects tab.
Each project in the list shows:
- The time the project was marked for deletion.
- The time the project is scheduled for final deletion.
- A Restore link to stop the project being eventually deleted.
Restore a project
DETAILS: Tier: Premium, Ultimate Offering: SaaS, self-managed
Prerequisites:
- You must have the Owner role for the project.
- The project must be marked for deletion.
To restore a project marked for deletion:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > General.
- Expand Advanced.
- In the Restore project section, select Restore project.
Archive a project
When you archive a project, the repository, packages, issues, merge requests, and all other features become read-only. Archived projects are also hidden from project lists.
To archive a project:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > General.
- Expand Advanced.
- In the Archive project section, select Archive project.
- To confirm, select OK.
Unarchive a project
When you unarchive a project, the read-only restriction is removed, and the project becomes available in project lists.
Prerequisites:
- You must be an administrator or have the Owner role for the project.
- Find the archived project.
- On the left sidebar, select Search or go to.
- Select View all my projects.
- Select Explore projects.
- In the Sort projects dropdown list, select Show archived projects.
- In the Filter by name field, enter the project name.
- Select the project link.
- On the left sidebar, select Settings > General.
- Under Advanced, select Expand.
- In the Unarchive project section, select Unarchive project.
- To confirm, select OK.
View project activity
To view the activity of a project:
-
On the left sidebar, select Search or go to and find your project.
-
Select Manage > Activity.
-
Optional. To filter activity by contribution type, select a tab:
- All: All contributions by project members.
- Push events: Push events in the project.
- Merge events: Accepted merge requests in the project.
- Issue events: Issues opened and closed in the project.
- Comments: Comments posted by project members.
- Designs: Designs added, updated, and removed in the project.
- Team: Members who joined and left the project.
Search in projects
To search through your projects, on the left sidebar, select Search or go to. GitLab filters as you type.
You can also look for the projects you starred (Starred projects).
You can Explore all public and internal projects available in GitLab.com, from which you can filter by visibility, through Trending, best rated with Most stars, or All of them.
You can sort projects by:
- Name
- Created date
- Updated date
- Owner
You can also choose to hide or show archived projects.
Filter projects by language
- Introduced in GitLab 15.9 with a flag named
project_language_search
. Enabled by default.- Generally available in GitLab 15.9. Feature flag
project_language_search
removed.
You can filter projects by the programming language they use. To do this:
- On the left sidebar, select Search or go to.
- Select either:
- View all your projects, to filter your projects.
- Explore, to filter all projects you can access.
- From the Language dropdown list, select the language you want to filter projects by.
A list of projects that use the selected language is displayed.
Rename a repository
A project's repository name defines its URL and its place on the file disk where GitLab is installed.
Prerequisites:
- You must be an administrator or have the Maintainer or Owner role for the project.
NOTE: When you change the repository path, users may experience issues if they push to, or pull from, the old URL. For more information, see redirects when renaming repositories.
To rename a repository:
- On the left sidebar, select Search or go to and find your project.
- Select Settings > General.
- Expand Advanced.
- In the Change path text box, edit the path.
- Select Change path.
Access the project overview page by using the project ID
- Project ID moved to the Actions menu in GitLab 16.7.
To access a project by using the project ID instead of its name,
go to https://gitlab.example.com/projects/<id>
.
To copy the project ID:
- On the left sidebar, select Search or go to and find your project.
- On the project overview page, in the upper-right corner, select Actions ({ellipsis_v}).
- Select Copy project ID.
For example, if in your personal namespace alex
you have a project my-project
with the ID 123456
, you can access the project
either at https://gitlab.example.com/alex/my-project
or https://gitlab.example.com/projects/123456
.
You might also need the project ID if you want to interact with it using the GitLab API.
Who can view the Project overview page
When you select a project, the Project overview page shows the project contents.
For public projects, and members of internal and private projects with permissions to view the project's code, the project landing page shows:
- A
README
or index file. - A list of directories in the project's repository.
For users without permission to view the project's code, the landing page shows:
- The wiki homepage.
- The list of issues in the project.
Leave a project
- The button to leave a project moved to the Actions menu in GitLab 16.7.
When you leave a project:
- You are no longer a project member and cannot contribute.
- All the issues and merge requests that were assigned to you are unassigned.
Prerequisites:
- You can leave a project this way only when a project is part of a group under a group namespace.
- You must be a direct member of the project.
To leave a project:
- On the left sidebar, select Search or go to and find your project.
- On the project overview page, in the upper-right corner, select Actions ({ellipsis_v}).
- Select Leave project, then Leave project again.
Add a compliance framework to a project
DETAILS: Tier: Free, Premium, Ultimate Offering: SaaS, self-managed
You can add compliance frameworks to projects in a group that has a compliance framework.
Manage project access through LDAP groups
You can use LDAP to manage group membership.
You cannot use LDAP groups to manage project access, but you can use the following workaround.
Prerequisites:
- You must integrate LDAP with GitLab.
- You must be an administrator.
- Create a group to track membership of your project.
- Set up LDAP synchronization for that group.
- To use LDAP groups to manage access to a project, add the LDAP-synchronized group as a member to the project.
Project aliases
DETAILS: Tier: Premium, Ultimate Offering: Self-managed
GitLab repositories are usually accessed with a namespace and a project name. When migrating frequently accessed repositories to GitLab, however, you can use project aliases to access those repositories with the original name. Accessing repositories through a project alias reduces the risk associated with migrating such repositories.
This feature is only available on Git over SSH. Also, only GitLab administrators can create project aliases, and they can only do so through the API. For more information, see the Project Aliases API documentation.
After an administrator creates an alias for a project, you can use the alias to clone the
repository. For example, if an administrator creates the alias gitlab
for the project
https://gitlab.com/gitlab-org/gitlab
, you can clone the project with
git clone git@gitlab.com:gitlab.git
instead of git clone git@gitlab.com:gitlab-org/gitlab.git
.