debian-mirror-gitlab/doc/user/project/index.md

Projects

In GitLab, you can create projects for hosting your codebase, use it as an issue tracker, collaborate on code, and continuously build, test, and deploy your app with built-in GitLab CI/CD.

Your projects can be available publicly, internally, or privately, at your choice. GitLab does not limit the number of private projects you create.

Project features

When you create a project in GitLab, you'll have access to a large number of features:

Repositories:

• Issue tracker: Discuss implementations with your team within issues
  • Issue Boards: Organize and prioritize your workflow
  • Multiple Issue Boards: Allow your teams to create their own workflows (Issue Boards) for the same project
• Repositories: Host your code in a fully integrated platform
  • Branches: use Git branching strategies to collaborate on code
  • Protected branches: Prevent collaborators from messing with history or pushing code without review
  • Protected tags: Control over who has permission to create tags, and prevent accidental update or deletion
  • Repository mirroring
  • Signing commits: use GPG to sign your commits
  • Deploy tokens: Manage project-based deploy tokens that allow permanent access to the repository and Container Registry.
• Web IDE

Issues and merge requests:

• Issue tracker: Discuss implementations with your team within issues
  • Issue Boards: Organize and prioritize your workflow
  • Multiple Issue Boards: Allow your teams to create their own workflows (Issue Boards) for the same project
• Merge Requests: Apply your branching strategy and get reviewed by your team
  • Merge Request Approvals: Ask for approval before implementing a change (STARTER)
  • Fix merge conflicts from the UI: Your Git diff tool right from GitLab's UI
  • Review Apps: Live preview the results of the changes proposed in a merge request in a per-branch basis
• Labels: Organize issues and merge requests by labels
• Time Tracking: Track estimate time and time spent on the conclusion of an issue or merge request
• Milestones: Work towards a target date
• Description templates: Define context-specific templates for issue and merge request description fields for your project
• Slash commands (quick actions): Textual shortcuts for common actions on issues or merge requests
• Autocomplete characters: Autocomplete references to users, groups, issues, merge requests, and other GitLab elements.
• Web IDE

GitLab CI/CD:

• GitLab CI/CD: GitLab's built-in Continuous Integration, Delivery, and Deployment tool
  • Container Registry: Build and push Docker images out-of-the-box
  • Auto Deploy: Configure GitLab CI/CD to automatically set up your app's deployment
  • Enable and disable GitLab CI
  • Pipelines: Configure and visualize your GitLab CI/CD pipelines from the UI
    • Scheduled Pipelines: Schedule a pipeline to start at a chosen time
    • Pipeline Graphs: View your entire pipeline from the UI
    • Job artifacts: Define, browse, and download job artifacts
    • Pipeline settings: Set up Git strategy (choose the default way your repository is fetched from GitLab in a job), timeout (defines the maximum amount of time in minutes that a job is able run), custom path for .gitlab-ci.yml, test coverage parsing, pipeline's visibility, and much more
  • Kubernetes cluster integration: Connecting your GitLab project with a Kubernetes cluster
  • Feature Flags: Feature flags allow you to ship a project in different flavors by dynamically toggling certain functionality (PREMIUM)
• GitLab Pages: Build, test, and deploy your static website with GitLab Pages

Other features:

• Wiki: document your GitLab project in an integrated Wiki.
• Snippets: store, share and collaborate on code snippets.
• Cycle Analytics: review your development lifecycle.
• Insights: configure the Insights that matter for your projects. (ULTIMATE)
• Security Dashboard: Security Dashboard. (ULTIMATE)
• Syntax highlighting: an alternative to customize your code blocks, overriding GitLab's default choice of language.
• Badges: badges for the project overview.
• Releases: a way to track deliverables in your project as snapshot in time of the source, build output, and other metadata or artifacts associated with a released version of your code.
• Conan packages: your private Conan repository in GitLab. (PREMIUM)
• Maven packages: your private Maven repository in GitLab. (PREMIUM)
• NPM packages: your private NPM package registry in GitLab. (PREMIUM)
• Code owners: specify code owners for certain files (STARTER)
• License Compliance: approve and blacklist licenses for projects. (ULTIMATE)
• Dependency List: view project dependencies. (ULTIMATE)

Project integrations

Integrate your project with Jira, Mattermost, Kubernetes, Slack, and a lot more.

New project

Learn how to create a new project in GitLab.

Fork a project

You can fork a project in order to:

• Collaborate on code by forking a project and creating a merge request from your fork to the upstream project
• Fork a sample project to work on the top of that

Project settings

Set the project's visibility level and the access levels to its various pages and perform actions like archiving, renaming or transferring a project.

Read through the documentation on project settings.

Import or export a project

• Import a project from:
  • GitHub to GitLab
  • Bitbucket to GitLab
  • Gitea to GitLab
  • FogBugz to GitLab
• Export a project from GitLab
• Importing and exporting projects between GitLab instances

CI/CD for external repositories (PREMIUM)

Instead of importing a repository directly to GitLab, you can connect your repository as a CI/CD project.

Read through the documentation on CI/CD for external repositories.

Project members

Learn how to add members to your projects.

Leave a project

Leave project will only display on the project's dashboard when a project is part of a group (under a group namespace). If you choose to leave a project you will no longer be a project member, therefore, unable to contribute.

Project's landing page

The project's landing page shows different information depending on the project's visibility settings and user permissions.

For public projects, and to members of internal and private projects with permissions to view the project's code:

• The content of a README or an index file is displayed (if any), followed by the list of directories within the project's repository.
• If the project doesn't contain either of these files, the visitor will see the list of files and directories of the repository.

For users without permissions to view the project's code:

• The wiki homepage is displayed, if any.
• The list of issues within the project is displayed.

Redirects when changing repository paths

When a repository path changes, it is essential to smoothly transition from the old location to the new one. GitLab provides two kinds of redirects: the web UI and Git push/pull redirects.

Depending on the situation, different things apply.

When renaming a user, changing a group path or renaming a repository:

• Existing web URLs for the namespace and anything under it (e.g., projects) will redirect to the new URLs.
• Starting with GitLab 10.3, existing Git remote URLs for projects under the namespace will redirect to the new remote URL. Every time you push/pull to a repository that has changed its location, a warning message to update your remote will be displayed instead of rejecting your action. This means that any automation scripts, or Git clients will continue to work after a rename, making any transition a lot smoother.
• The redirects will be available as long as the original path is not claimed by another group, user or project.

Use your project as a Go package

Any project can be used as a Go package including private projects in subgroups. GitLab responds correctly to go get and godoc.org discovery requests, including the go-import and go-source meta tags, respectively. To use packages hosted in private projects with the go get command, use a .netrc file and a personal access token in the password field.

For example:

machine example.gitlab.com
login <gitlab_user_name>
password <personal_access_token>

Access project page with project ID

Introduced in GitLab 11.8.

To quickly access a project from the GitLab UI using the project ID, visit the /projects/:id URL in your browser or other tool accessing the project.

Project aliases (PREMIUM ONLY)

Introduced in GitLab Premium 12.1.

When migrating repositories to GitLab and they are being accessed by other systems, it's very useful to be able to access them using the same name especially when they are a lot. It reduces the risk of changing significant number of Git URLs in a large number of systems.

GitLab provides a functionality to help with this. In GitLab, repositories are usually accessed with a namespace and project name. It is also possible to access them via a project alias. This feature is only available on Git over SSH.

A project alias can be only created via API and only by GitLab administrators. Follow the Project Aliases API documentation for more details.

Once an alias has been created for a project (e.g., an alias gitlab for the project https://gitlab.com/gitlab-org/gitlab), the repository can be cloned using the alias (e.g git clone git@gitlab.com:gitlab.git instead of git clone git@gitlab.com:gitlab-org/gitlab.git).

Project APIs

There are numerous APIs to use with your projects:

• Badges
• Clusters
• Threads
• General
• Import/export
• Issue Board
• Labels
• Markdown
• Merge Requests
• Milestones
• Services
• Snippets
• Templates
• Traffic
• Variables
• Aliases