Project

class Project : KotlinCustomResource

Example Usage

Import

$ pulumi import gitlab:index/project:Project You can import a project state using `<resource> <id>`. The

id can be whatever the get_single_project takes for its :id value, so for example:

$ pulumi import gitlab:index/project:Project example richardc/example

NOTE: the import_url_username and import_url_password cannot be imported.

Properties

Link copied to clipboard

Set to true if you want to treat skipped pipelines as if they finished with success.

Link copied to clipboard

Set the analytics access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Number of merge request approvals required for merging. Default is 0. This field does not work well in combination with the gitlab.ProjectApprovalRule resource and is most likely gonna be deprecated in a future GitLab version (see this upstream epic). In the meantime we recommend against using this attribute and use gitlab.ProjectApprovalRule instead.

Link copied to clipboard
val archived: Output<Boolean>?

Whether the project is in read-only mode (archived). Repositories can be archived/unarchived by toggling this parameter.

Link copied to clipboard

Set to true to archive the project instead of deleting on destroy. If set to true it will entire omit the DELETE operation.

Link copied to clipboard

Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.

Link copied to clipboard

Set whether auto-closing referenced issues on default branch.

Link copied to clipboard

Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.

Link copied to clipboard

Enable Auto DevOps for this project.

Link copied to clipboard
val avatar: Output<String>?

A local path to the avatar image to upload. Note: not available for imported resources.

Link copied to clipboard
val avatarHash: Output<String>

The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.

Link copied to clipboard
val avatarUrl: Output<String>

The URL of the avatar image.

Link copied to clipboard

Test coverage parsing for the project. This is deprecated feature in GitLab 15.0.

Link copied to clipboard

The Git strategy. Defaults to fetch. Valid values are clone, fetch.

Link copied to clipboard

Set the builds access level. Valid values are disabled, private, enabled.

Link copied to clipboard
val buildTimeout: Output<Int>

The maximum amount of time, in seconds, that a job can run.

Link copied to clipboard
val ciConfigPath: Output<String>?

Custom Path to CI config file.

Link copied to clipboard
val ciDefaultGitDepth: Output<Int>

Default number of revisions for shallow cloning.

Link copied to clipboard

When a new deployment job starts, skip older deployment jobs that are still pending.

Link copied to clipboard

The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one

Link copied to clipboard

Use separate caches for protected branches.

Link copied to clipboard

Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.

Link copied to clipboard

Set visibility of container registry, for this project. Valid values are disabled, private, enabled.

Link copied to clipboard

Enable container registry for the project.

Link copied to clipboard
val defaultBranch: Output<String>

The default branch for the project.

Link copied to clipboard
val description: Output<String>?

A description of the project.

Link copied to clipboard
val emailsDisabled: Output<Boolean>

Disable email notifications.

Link copied to clipboard
val emailsEnabled: Output<Boolean>

Enable email notifications.

Link copied to clipboard
val emptyRepo: Output<Boolean>

Whether the project is empty.

Link copied to clipboard

Set the environments access level. Valid values are disabled, private, enabled.

Link copied to clipboard

The classification label for the project.

Link copied to clipboard

Set the feature flags access level. Valid values are disabled, private, enabled.

Link copied to clipboard
val forkedFromProjectId: Output<Int>?

The id of the project to fork. During create the project is forked and during an update the fork relation is changed.

Link copied to clipboard

Set the forking access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Enable group runners for this project.

Link copied to clipboard

For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires usecustomtemplate to be true (enterprise edition).

Link copied to clipboard
val httpUrlToRepo: Output<String>

URL that can be provided to git clone to clone the

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val importUrl: Output<String>?

Git URL to a repository to be imported. Together with mirror = true it will setup a Pull Mirror. This can also be used together with forked_from_project_id to setup a Pull Mirror for a fork. The fork takes precedence over the import. Make sure to provide the credentials in import_url_username and import_url_password. GitLab never returns the credentials, thus the provider cannot detect configuration drift in the credentials. They can also not be imported using pulumi import. See the examples section for how to properly use it.

Link copied to clipboard

The password for the import_url. The value of this field is used to construct a valid import_url and is only related to the provider. This field cannot be imported using pulumi import. See the examples section for how to properly use it.

Link copied to clipboard

The username for the import_url. The value of this field is used to construct a valid import_url and is only related to the provider. This field cannot be imported using pulumi import. See the examples section for how to properly use it.

Link copied to clipboard

Set the infrastructure access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Create main branch with first commit containing a README.md file.

Link copied to clipboard

Set the issues access level. Valid values are disabled, private, enabled.

Link copied to clipboard
val issuesEnabled: Output<Boolean>

Enable issue tracking for the project.

Link copied to clipboard
val issuesTemplate: Output<String>?

Sets the template for new issues in the project.

Link copied to clipboard

Disable or enable the ability to keep the latest artifact for this project.

Link copied to clipboard
val lfsEnabled: Output<Boolean>

Enable LFS for the project.

Link copied to clipboard

Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)

Link copied to clipboard
val mergeMethod: Output<String>

Set the merge method. Valid values are merge, rebase_merge, ff.

Link copied to clipboard

Enable or disable merge pipelines.

Link copied to clipboard

Set the merge requests access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Enable merge requests for the project.

Link copied to clipboard

Sets the template for new merge requests in the project.

Link copied to clipboard

Enable or disable merge trains. Requires merge_pipelines_enabled to be set to true to take effect.

Link copied to clipboard
val mirror: Output<Boolean>?

Enable project pull mirror.

Link copied to clipboard

Enable overwrite diverged branches for a mirrored project.

Link copied to clipboard

Enable trigger builds on pushes for a mirrored project.

Link copied to clipboard

Set the monitor access level. Valid values are disabled, private, enabled.

Link copied to clipboard

For forked projects, target merge requests to this project. If false, the target will be the upstream project.

Link copied to clipboard
val name: Output<String>

The name of the project.

Link copied to clipboard
val namespaceId: Output<Int>

The namespace (group or user) of the project. Defaults to your user.

Set to true if you want allow merges only if all discussions are resolved.

Link copied to clipboard

Set to true if you want allow merges only if a pipeline succeeds.

Link copied to clipboard

Enable only mirror protected branches for a mirrored project.

Link copied to clipboard

Enable packages repository for the project.

Link copied to clipboard

Enable pages access control. Valid values are public, private, enabled, disabled.

Link copied to clipboard
val path: Output<String>?

The path of the repository.

Link copied to clipboard

The path of the repository with namespace.

Link copied to clipboard

Enable pipelines for the project. The pipelines_enabled field is being sent as jobs_enabled in the GitLab API calls.

Link copied to clipboard

Show link to create/view merge request when pushing from the command line

Link copied to clipboard
val publicBuilds: Output<Boolean>

If true, jobs can be viewed by non-project members.

Link copied to clipboard
val publicJobs: Output<Boolean>

If true, jobs can be viewed by non-project members.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Push rules for the project.

Link copied to clipboard

Set the releases access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Enable Delete source branch option by default for all new merge requests.

Link copied to clipboard

Set the repository access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Which storage shard the repository is on. (administrator only)

Link copied to clipboard

Allow users to request member access.

Link copied to clipboard

Set the requirements access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Automatically resolve merge request diffs discussions on lines changed with a push.

Link copied to clipboard

Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.

Link copied to clipboard
val runnersToken: Output<String>

Registration token to use during runner setup.

Link copied to clipboard

Set the security and compliance access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Enable shared runners for this project.

Link copied to clipboard

If true, the default behavior to wait for the default branch protection to be created is skipped. This is necessary if the current user is not an admin and the default branch protection is disabled on an instance-level. There is currently no known way to determine if the default branch protection is disabled on an instance-level for non-admin users. This attribute is only used during resource creation, thus changes are suppressed and the attribute cannot be imported.

Link copied to clipboard

Set the snippets access level. Valid values are disabled, private, enabled.

Link copied to clipboard

Enable snippets for the project.

Link copied to clipboard

Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)

Link copied to clipboard
val squashOption: Output<String>

Squash commits when merge request. Valid values are never, always, default_on, or default_off. The default value is default_off. GitLab >= 14.1

Link copied to clipboard
val sshUrlToRepo: Output<String>

URL that can be provided to git clone to clone the

Link copied to clipboard

The commit message used to apply merge request suggestions.

Link copied to clipboard
val tags: Output<List<String>>

The list of tags for a project; put array of tags, that should be finally assigned to a project. Use topics instead.

Link copied to clipboard
val templateName: Output<String>?

When used without usecustomtemplate, name of a built-in project template. When used with usecustomtemplate, name of a custom project template. This option is mutually exclusive with template_project_id.

Link copied to clipboard
val templateProjectId: Output<Int>?

When used with usecustomtemplate, project ID of a custom project template. This is preferable to using templatename since templatename may be ambiguous (enterprise edition). This option is mutually exclusive with template_name. See gitlab.GroupProjectFileTemplate to set a project as a template project. If a project has not been set as a template, using it here will result in an error.

Link copied to clipboard
val topics: Output<List<String>>

The list of topics for the project.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

Use either custom instance or group (with groupwithprojecttemplatesid) project template (enterprise edition).

Link copied to clipboard
val visibilityLevel: Output<String>

Set to public to create a public project. Valid values are private, internal, public.

Link copied to clipboard
val webUrl: Output<String>

URL that can be used to find the project in a browser.

Link copied to clipboard
val wikiAccessLevel: Output<String>

Set the wiki access level. Valid values are disabled, private, enabled.

Link copied to clipboard
val wikiEnabled: Output<Boolean>

Enable wiki for the project.