pulumi-gitlab 9.5.0a1762841292__tar.gz → 9.5.0a1763071959__tar.gz

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulumi_gitlab
-Version: 9.5.0a1762841292
+Version: 9.5.0a1763071959
 Summary: A Pulumi package for creating and managing GitLab resources.
 License: Apache-2.0
 Project-URL: Homepage, https://pulumi.io

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/get_user.py

@@ -424,6 +424,22 @@ def get_user(email: Optional[_builtins.str] = None,
 
     **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#get-a-single-user)
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gitlab as gitlab
+    import pulumi_std as std
+
+    example = gitlab.get_user(username="myuser")
+    # Example using `for_each`
+    example_two = {__key: gitlab.get_user(username=__value) for __key, __value in std.toset(input=[
+        "user1",
+        "user2",
+        "user3",
+    ]).result}
+    ```
+
 
     :param _builtins.str email: The public email address of the user.
     :param _builtins.bool email_exact_match: (Experimental) If true, returns only an exact match. Otherwise, fuzzy matching might return the closest result. If no exact match is available, the data source returns an error.
@@ -487,6 +503,22 @@ def get_user_output(email: Optional[pulumi.Input[Optional[_builtins.str]]] = Non
 
     **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#get-a-single-user)
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gitlab as gitlab
+    import pulumi_std as std
+
+    example = gitlab.get_user(username="myuser")
+    # Example using `for_each`
+    example_two = {__key: gitlab.get_user(username=__value) for __key, __value in std.toset(input=[
+        "user1",
+        "user2",
+        "user3",
+    ]).result}
+    ```
+
 
     :param _builtins.str email: The public email address of the user.
     :param _builtins.bool email_exact_match: (Experimental) If true, returns only an exact match. Otherwise, fuzzy matching might return the closest result. If no exact match is available, the data source returns an error.

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/group_level_mr_approvals.py

@@ -264,6 +264,24 @@ class GroupLevelMrApprovals(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        foo = gitlab.Group("foo",
+            name="test_group",
+            path="test_group",
+            description="An example group")
+        foo_group_level_mr_approvals = gitlab.GroupLevelMrApprovals("foo",
+            group=foo.id,
+            allow_author_approval=True,
+            allow_committer_approval=True,
+            allow_overrides_to_approver_list_per_merge_request=True,
+            retain_approvals_on_push=True,
+            selective_code_owner_removals=False,
+            require_reauthentication_to_approve=True)
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_group_level_mr_approvals`. For example:
@@ -308,6 +326,24 @@ class GroupLevelMrApprovals(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        foo = gitlab.Group("foo",
+            name="test_group",
+            path="test_group",
+            description="An example group")
+        foo_group_level_mr_approvals = gitlab.GroupLevelMrApprovals("foo",
+            group=foo.id,
+            allow_author_approval=True,
+            allow_committer_approval=True,
+            allow_overrides_to_approver_list_per_merge_request=True,
+            retain_approvals_on_push=True,
+            selective_code_owner_removals=False,
+            require_reauthentication_to_approve=True)
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_group_level_mr_approvals`. For example:

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/group_service_account_access_token.py

@@ -348,6 +348,51 @@ class GroupServiceAccountAccessToken(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        # This must be a top-level group
+        example = gitlab.Group("example",
+            name="example",
+            path="example",
+            description="An example group")
+        # The service account against the top-level group
+        example_sa = gitlab.GroupServiceAccount("example_sa",
+            group=example.id,
+            name="example-name",
+            username="example-username")
+        # To assign the service account to a group
+        example_membership = gitlab.GroupMembership("example_membership",
+            group_id=example.id,
+            user_id=example_sa.service_account_id,
+            access_level="developer",
+            expires_at="2020-03-14")
+        # The service account access token with no expiry
+        example_sa_token_no_expiry = gitlab.GroupServiceAccountAccessToken("example_sa_token_no_expiry",
+            group=example.id,
+            user_id=example_sa.service_account_id,
+            name="Example service account access token",
+            scopes=["api"])
+        # The service account access token with expires at
+        example_sa_token_expires_at = gitlab.GroupServiceAccountAccessToken("example_sa_token_expires_at",
+            group=example.id,
+            user_id=example_sa.service_account_id,
+            name="Example service account access token",
+            expires_at="2020-03-14",
+            scopes=["api"])
+        # The service account access token with rotation configuration
+        example_sa_token_rotation_configuration = gitlab.GroupServiceAccountAccessToken("example_sa_token_rotation_configuration",
+            group=example.id,
+            user_id=example_sa.service_account_id,
+            name="Example service account access token",
+            rotation_configuration={
+                "rotate_before_days": 2,
+                "expiration_days": 7,
+            },
+            scopes=["api"])
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_group_service_account_access_token`. For example:
@@ -407,6 +452,51 @@ class GroupServiceAccountAccessToken(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        # This must be a top-level group
+        example = gitlab.Group("example",
+            name="example",
+            path="example",
+            description="An example group")
+        # The service account against the top-level group
+        example_sa = gitlab.GroupServiceAccount("example_sa",
+            group=example.id,
+            name="example-name",
+            username="example-username")
+        # To assign the service account to a group
+        example_membership = gitlab.GroupMembership("example_membership",
+            group_id=example.id,
+            user_id=example_sa.service_account_id,
+            access_level="developer",
+            expires_at="2020-03-14")
+        # The service account access token with no expiry
+        example_sa_token_no_expiry = gitlab.GroupServiceAccountAccessToken("example_sa_token_no_expiry",
+            group=example.id,
+            user_id=example_sa.service_account_id,
+            name="Example service account access token",
+            scopes=["api"])
+        # The service account access token with expires at
+        example_sa_token_expires_at = gitlab.GroupServiceAccountAccessToken("example_sa_token_expires_at",
+            group=example.id,
+            user_id=example_sa.service_account_id,
+            name="Example service account access token",
+            expires_at="2020-03-14",
+            scopes=["api"])
+        # The service account access token with rotation configuration
+        example_sa_token_rotation_configuration = gitlab.GroupServiceAccountAccessToken("example_sa_token_rotation_configuration",
+            group=example.id,
+            user_id=example_sa.service_account_id,
+            name="Example service account access token",
+            rotation_configuration={
+                "rotate_before_days": 2,
+                "expiration_days": 7,
+            },
+            scopes=["api"])
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_group_service_account_access_token`. For example:

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/project_approval_rule.py

@@ -370,6 +370,66 @@ class ProjectApprovalRule(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+        import pulumi_std as std
+
+        example_one = gitlab.ProjectApprovalRule("example-one",
+            project="5",
+            name="Example Rule",
+            approvals_required=3,
+            user_ids=[
+                50,
+                500,
+            ],
+            group_ids=[51])
+        # With Protected Branch IDs
+        example = gitlab.BranchProtection("example",
+            project="5",
+            branch="release/*",
+            push_access_level="maintainer",
+            merge_access_level="developer")
+        example_two = gitlab.ProjectApprovalRule("example-two",
+            project="5",
+            name="Example Rule 2",
+            approvals_required=3,
+            user_ids=[
+                50,
+                500,
+            ],
+            group_ids=[51],
+            protected_branch_ids=[example.branch_protection_id])
+        # Example using `data.gitlab_user` and `for` loop
+        users = {__key: gitlab.get_user(username=__value) for __key, __value in std.toset(input=[
+            "user1",
+            "user2",
+            "user3",
+        ]).result}
+        example_three = gitlab.ProjectApprovalRule("example-three",
+            project="5",
+            name="Example Rule 3",
+            approvals_required=3,
+            user_ids=[user.id for user in users])
+        # Example using `approval_rule` using `any_approver` as rule type
+        any_approver = gitlab.ProjectApprovalRule("any_approver",
+            project="5",
+            name="Any name",
+            rule_type="any_approver",
+            approvals_required=1)
+        # Example using `applies_to_all_protected_branches`
+        example_four = gitlab.ProjectApprovalRule("example-four",
+            project="5",
+            name="Example Rule 4",
+            approvals_required=3,
+            user_ids=[
+                50,
+                500,
+            ],
+            group_ids=[51],
+            applies_to_all_protected_branches=True)
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_project_approval_rule`. For example:
@@ -414,6 +474,66 @@ class ProjectApprovalRule(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+        import pulumi_std as std
+
+        example_one = gitlab.ProjectApprovalRule("example-one",
+            project="5",
+            name="Example Rule",
+            approvals_required=3,
+            user_ids=[
+                50,
+                500,
+            ],
+            group_ids=[51])
+        # With Protected Branch IDs
+        example = gitlab.BranchProtection("example",
+            project="5",
+            branch="release/*",
+            push_access_level="maintainer",
+            merge_access_level="developer")
+        example_two = gitlab.ProjectApprovalRule("example-two",
+            project="5",
+            name="Example Rule 2",
+            approvals_required=3,
+            user_ids=[
+                50,
+                500,
+            ],
+            group_ids=[51],
+            protected_branch_ids=[example.branch_protection_id])
+        # Example using `data.gitlab_user` and `for` loop
+        users = {__key: gitlab.get_user(username=__value) for __key, __value in std.toset(input=[
+            "user1",
+            "user2",
+            "user3",
+        ]).result}
+        example_three = gitlab.ProjectApprovalRule("example-three",
+            project="5",
+            name="Example Rule 3",
+            approvals_required=3,
+            user_ids=[user.id for user in users])
+        # Example using `approval_rule` using `any_approver` as rule type
+        any_approver = gitlab.ProjectApprovalRule("any_approver",
+            project="5",
+            name="Any name",
+            rule_type="any_approver",
+            approvals_required=1)
+        # Example using `applies_to_all_protected_branches`
+        example_four = gitlab.ProjectApprovalRule("example-four",
+            project="5",
+            name="Example Rule 4",
+            approvals_required=3,
+            user_ids=[
+                50,
+                500,
+            ],
+            group_ids=[51],
+            applies_to_all_protected_branches=True)
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_project_approval_rule`. For example:

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/project_job_token_scope.py

@@ -145,6 +145,8 @@ class ProjectJobTokenScope(pulumi.CustomResource):
 
         **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_job_token_scopes/)
 
+        ## Example Usage
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_project_job_token_scope`. For example:
@@ -187,6 +189,8 @@ class ProjectJobTokenScope(pulumi.CustomResource):
 
         **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_job_token_scopes/)
 
+        ## Example Usage
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_project_job_token_scope`. For example:

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/project_wiki_page.py

@@ -207,6 +207,19 @@ class ProjectWikiPage(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        example = gitlab.ProjectWikiPage("example",
+            project="12345",
+            slug="test-wiki-page",
+            title="Test Wiki Page",
+            content=\"\"\"This is a test content for the wiki page.
+        And this is a second line of content.
+        \"\"\")
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_project_wiki_page`. For example:
@@ -249,6 +262,19 @@ class ProjectWikiPage(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        example = gitlab.ProjectWikiPage("example",
+            project="12345",
+            slug="test-wiki-page",
+            title="Test Wiki Page",
+            content=\"\"\"This is a test content for the wiki page.
+        And this is a second line of content.
+        \"\"\")
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_project_wiki_page`. For example:

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/pulumi-plugin.json

@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "gitlab",
-  "version": "9.5.0-alpha.1762841292"
+  "version": "9.5.0-alpha.1763071959"
 }

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/user_runner.py

@@ -451,10 +451,10 @@ class UserRunner(pulumi.CustomResource):
           session_timeout = 1800
 
         [[runners]]
-          name = "my_gitlab_runner"
-          url = "https://example.gitlab.com"
-          token = "{token}"
-          executor = "docker"
+          name = \\"my_gitlab_runner\\"
+          url = \\"https://example.gitlab.com\\"
+          token = \\"{token}\\"
+          executor = \\"docker\\"
 
           [runners.custom_build_dir]
           [runners.cache]
@@ -463,12 +463,12 @@ class UserRunner(pulumi.CustomResource):
             [runners.cache.azure]
           [runners.docker]
             tls_verify = false
-            image = "ubuntu"
+            image = \\"ubuntu\\"
             privileged = true
             disable_entrypoint_overwrite = false
             oom_kill_disable = false
             disable_cache = false
-            volumes = ["/cache", "/certs/client"]
+            volumes = [\\"/cache\\", \\"/certs/client\\"]
             shm_size = 0
         \"\"\")
         ```
@@ -551,10 +551,10 @@ class UserRunner(pulumi.CustomResource):
           session_timeout = 1800
 
         [[runners]]
-          name = "my_gitlab_runner"
-          url = "https://example.gitlab.com"
-          token = "{token}"
-          executor = "docker"
+          name = \\"my_gitlab_runner\\"
+          url = \\"https://example.gitlab.com\\"
+          token = \\"{token}\\"
+          executor = \\"docker\\"
 
           [runners.custom_build_dir]
           [runners.cache]
@@ -563,12 +563,12 @@ class UserRunner(pulumi.CustomResource):
             [runners.cache.azure]
           [runners.docker]
             tls_verify = false
-            image = "ubuntu"
+            image = \\"ubuntu\\"
             privileged = true
             disable_entrypoint_overwrite = false
             oom_kill_disable = false
             disable_cache = false
-            volumes = ["/cache", "/certs/client"]
+            volumes = [\\"/cache\\", \\"/certs/client\\"]
             shm_size = 0
         \"\"\")
         ```

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab/value_stream_analytics.py

@@ -181,6 +181,50 @@ class ValueStreamAnalytics(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        project = gitlab.ValueStreamAnalytics("project",
+            name="TEST",
+            project_full_path="test/project",
+            stages=[
+                {
+                    "name": "Issue",
+                    "custom": False,
+                    "hidden": False,
+                },
+                {
+                    "name": "Issue Labels",
+                    "custom": True,
+                    "hidden": False,
+                    "start_event_identifier": "ISSUE_LABEL_ADDED",
+                    "start_event_label_id": "gid://gitlab/ProjectLabel/0",
+                    "end_event_identifier": "ISSUE_LABEL_REMOVED",
+                    "end_event_label_id": "gid://gitlab/ProjectLabel/1",
+                },
+            ])
+        group = gitlab.ValueStreamAnalytics("group",
+            name="TEST",
+            group_full_path="test/group",
+            stages=[
+                {
+                    "name": "Issue",
+                    "custom": False,
+                    "hidden": False,
+                },
+                {
+                    "name": "Issue Labels",
+                    "custom": True,
+                    "hidden": False,
+                    "start_event_identifier": "ISSUE_LABEL_ADDED",
+                    "start_event_label_id": "gid://gitlab/GroupLabel/0",
+                    "end_event_identifier": "ISSUE_LABEL_REMOVED",
+                    "end_event_label_id": "gid://gitlab/GroupLabel/1",
+                },
+            ])
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_value_stream_analytics`. For example:
@@ -229,6 +273,50 @@ class ValueStreamAnalytics(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gitlab as gitlab
+
+        project = gitlab.ValueStreamAnalytics("project",
+            name="TEST",
+            project_full_path="test/project",
+            stages=[
+                {
+                    "name": "Issue",
+                    "custom": False,
+                    "hidden": False,
+                },
+                {
+                    "name": "Issue Labels",
+                    "custom": True,
+                    "hidden": False,
+                    "start_event_identifier": "ISSUE_LABEL_ADDED",
+                    "start_event_label_id": "gid://gitlab/ProjectLabel/0",
+                    "end_event_identifier": "ISSUE_LABEL_REMOVED",
+                    "end_event_label_id": "gid://gitlab/ProjectLabel/1",
+                },
+            ])
+        group = gitlab.ValueStreamAnalytics("group",
+            name="TEST",
+            group_full_path="test/group",
+            stages=[
+                {
+                    "name": "Issue",
+                    "custom": False,
+                    "hidden": False,
+                },
+                {
+                    "name": "Issue Labels",
+                    "custom": True,
+                    "hidden": False,
+                    "start_event_identifier": "ISSUE_LABEL_ADDED",
+                    "start_event_label_id": "gid://gitlab/GroupLabel/0",
+                    "end_event_identifier": "ISSUE_LABEL_REMOVED",
+                    "end_event_label_id": "gid://gitlab/GroupLabel/1",
+                },
+            ])
+        ```
+
         ## Import
 
         Starting in Terraform v1.5.0, you can use an import block to import `gitlab_value_stream_analytics`. For example:

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pulumi_gitlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulumi_gitlab
-Version: 9.5.0a1762841292
+Version: 9.5.0a1763071959
 Summary: A Pulumi package for creating and managing GitLab resources.
 License: Apache-2.0
 Project-URL: Homepage, https://pulumi.io

{pulumi_gitlab-9.5.0a1762841292 → pulumi_gitlab-9.5.0a1763071959}/pyproject.toml

@@ -5,7 +5,7 @@
   keywords = ["pulumi", "gitlab"]
   readme = "README.md"
   requires-python = ">=3.9"
-  version = "9.5.0a1762841292"
+  version = "9.5.0a1763071959"
   [project.license]
     text = "Apache-2.0"
   [project.urls]