gitlab-projects-settings 2.0.1__tar.gz → 2.1.0__tar.gz

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/.gitlab-ci.yml

@@ -137,6 +137,7 @@ typings:
   stage: prepare
   image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:codestyle
   variables:
+    MYPY_CACHE_DIR: /dev/null
     MYPY_FORCE_COLOR: 1
     TERM: ansi
   script:

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/CHANGELOG.md

@@ -1,4 +1,33 @@
 
+<a name="2.1.0"></a>
+## [2.1.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.0.2...2.1.0) (2024-04-28)
+
+### Bug Fixes
+
+* **entrypoint:** fix project '--update-description' logs output
+
+### Features
+
+* **entrypoint:** sort groups and projects recursively
+* **entrypoint:** keep description if already contains group
+
+
+<a name="2.0.2"></a>
+## [2.0.2](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.0.1...2.0.2) (2024-04-28)
+
+### Ci
+
+* **gitlab-ci:** disable 'typing' mypy caching with 'MYPY_CACHE_DIR'
+
+### Documentation
+
+* **readme:** document GitLab tokens' creation instructions
+
+### Features
+
+* **main:** limit '--help' width to terminal width or 120 chars
+
+
 <a name="2.0.1"></a>
 ## [2.0.1](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.0.0...2.0.1) (2024-04-28)
 

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 2.0.1
+Version: 2.1.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -50,6 +50,10 @@ of groups, subgroups and projects, using multiple available options.
 Repetitive tasks can be performed accross multiple projects at once,  
 for example protecting tags and branches, or setting a new avatar recursively.
 
+The following step is required before using the tool:
+
+- The GitLab user tokens must be created with an `api` scope (a short expiration date is recommended)
+
 ---
 
 ## Usage

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/README.md

@@ -16,6 +16,10 @@ of groups, subgroups and projects, using multiple available options.
 Repetitive tasks can be performed accross multiple projects at once,  
 for example protecting tags and branches, or setting a new avatar recursively.
 
+The following step is required before using the tool:
+
+- The GitLab user tokens must be created with an `api` scope (a short expiration date is recommended)
+
 ---
 
 ## Usage

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/gitlab_projects_settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 2.0.1
+Version: 2.1.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -50,6 +50,10 @@ of groups, subgroups and projects, using multiple available options.
 Repetitive tasks can be performed accross multiple projects at once,  
 for example protecting tags and branches, or setting a new avatar recursively.
 
+The following step is required before using the tool:
+
+- The GitLab user tokens must be created with an `api` scope (a short expiration date is recommended)
+
 ---
 
 ## Usage

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/src/cli/entrypoint.py

@@ -76,11 +76,14 @@ class Entrypoint:
 
             # Iterate through subgroups
             if not options.exclude_subgroups:
-                for group_subgroup in group.descendant_groups.list(
-                        get_all=True,
-                        include_subgroups=True,
-                        order_by='path',
-                        sort='asc',
+                for group_subgroup in sorted(
+                        group.descendant_groups.list(
+                            get_all=True,
+                            include_subgroups=True,
+                            order_by='path',
+                            sort='asc',
+                        ),
+                        key=lambda item: item.full_path,
                 ):
                     Entrypoint.group(
                         options,
@@ -91,11 +94,14 @@ class Entrypoint:
 
             # Iterate through projects
             if not options.exclude_projects:
-                for group_project in group.projects.list(
-                        get_all=True,
-                        include_subgroups=not options.exclude_subgroups,
-                        order_by='path',
-                        sort='asc',
+                for group_project in sorted(
+                        group.projects.list(
+                            get_all=True,
+                            include_subgroups=not options.exclude_subgroups,
+                            order_by='path',
+                            sort='asc',
+                        ),
+                        key=lambda item: item.path_with_namespace,
                 ):
                     Entrypoint.project(
                         options,
@@ -152,12 +158,18 @@ class Entrypoint:
                     parent_description,
                     parent_name,
                 )
-            description = f'{GitLabFeature.Helper.capitalize(group.name)}' \
-                          f'{parent_description_text}'
-            gitlab.group_set_description(criteria, description)
-            print(f'{Colors.BOLD}   - Updated description: '
-                  f'{Colors.CYAN}{description}'
-                  f'{Colors.RESET}')
+            if not parent_description_text or not group.description.endswith(
+                    f'{parent_description_text}'):
+                description = f'{GitLabFeature.Helper.capitalize(group.name)}' \
+                            f'{parent_description_text}'
+                gitlab.group_set_description(criteria, description)
+                print(f'{Colors.BOLD}   - Updated description: '
+                      f'{Colors.CYAN}{description}'
+                      f'{Colors.RESET}')
+            else:
+                print(f'{Colors.BOLD}   - Kept description: '
+                      f'{Colors.GREEN}{group.description}'
+                      f'{Colors.RESET}')
 
         # Reset group members
         if options.reset_members:
@@ -210,12 +222,17 @@ class Entrypoint:
                 group.description,
                 group.name,
             )
-            description = f'{GitLabFeature.Helper.capitalize(project.name)}' \
-                          f' - {group_description}'
-            gitlab.project_set_description(criteria, description)
-            print(f'{Colors.BOLD}   - Updated description: '
-                  f'{Colors.CYAN}{group_description}'
-                  f'{Colors.RESET}')
+            if not project.description.endswith(f' - {group_description}'):
+                description = f'{GitLabFeature.Helper.capitalize(project.name)}' \
+                              f' - {group_description}'
+                gitlab.project_set_description(criteria, description)
+                print(f'{Colors.BOLD}   - Updated description: '
+                      f'{Colors.CYAN}{description}'
+                      f'{Colors.RESET}')
+            else:
+                print(f'{Colors.BOLD}   - Kept description: '
+                      f'{Colors.GREEN}{project.description}'
+                      f'{Colors.RESET}')
 
         # Reset project features
         if options.reset_features:

{gitlab_projects_settings-2.0.1 → gitlab_projects_settings-2.1.0}/src/cli/main.py

@@ -3,6 +3,7 @@
 # Standard libraries
 from argparse import (_ArgumentGroup, ArgumentParser, Namespace, RawTextHelpFormatter)
 from os import environ
+from shutil import get_terminal_size
 from sys import exit as sys_exit
 
 # Components
@@ -27,6 +28,10 @@ def main() -> None:
         formatter_class=lambda prog: RawTextHelpFormatter(
             prog,
             max_help_position=30,
+            width=min(
+                120,
+                get_terminal_size().columns - 2,
+            ),
         ),
     )