Commit 7fc5cea8 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch 'fix-api-delay-doc-and-make-it-a-float' into 'main' 

fix: allow float for API delay in seconds, and document default is 0

See merge request to-be-continuous/tools/gitlab-butler!57
parents 78746577 560668d9

README.md

+2 −2
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ options: 
  --verbose             verbose logs

  --halt-on-error       halt whenever an error occurs

  --delay-between-api-calls DELAY_BETWEEN_API_CALLS

                        delay between GitLab API calls, in seconds

                        delay between GitLab API calls, in seconds (float number, default = 0)

  --pipeline-deletion-limit PIPELINE_DELETION_LIMIT

                        maximum number of pipelines deleted per project

  --pipelines-keep-per-branch PIPELINES_KEEP_PER_BRANCH
@@ -59,7 +59,7 @@ options: 
| `--dry-run`                         | `$DRY_RUN`                     | dry run (don't execute any write action)                                                       |

| `--verbose`                         | `$VERBOSE`                     | verbose logs                                                                                   |

| `--halt-on-error`                   | `$HALT_ON_ERROR`               | halt when an error occurs                                                                      |

| `--delay-between-api-calls-in-secs` | `$API_DELAY_SECONDS`           | delay between GitLab API calls, in seconds (default = 3 seconds)                               |

| `--delay-between-api-calls-in-secs` | `$API_DELAY_SECONDS`           | delay between GitLab API calls, in seconds (float number, default = 0)                         |

| `--pipeline-deletion-limit`         | `$PIPELINES_DELETION_LIMIT`    | maximum number of pipelines deleted per project (default = no limit)                           |

| `--pipelines-keep-per-branch`       | `$PIPELINES_KEEP_PER_BRANCH`   | number of pipelines to keep per branch (⚠ branch MUST still exist)                             |

| `--pipelines-keep-per-tag`          | `$PIPELINES_KEEP_PER_TAG`      | number of pipelines to keep per tag (⚠ tag MUST still exist)                                   |

gitlab_butler/butler.py

+1 −1
Original line number Diff line number Diff line
@@ -56,7 +56,7 @@ class Butler: 
            verbose: bool = False,

            debug: bool = False,

            continue_on_error: bool = False,

            delay_between_api_call: int = 0,

            delay_between_api_call: float = 0,

            pipeline_deletion_limit: int = 0,

            default_cfg: ButlerCfg = ButlerCfg(),

    ) -> None:

gitlab_butler/main.py

+2 −2
Original line number Diff line number Diff line
@@ -77,8 +77,8 @@ def generate_parser() -> argparse.ArgumentParser: 
    )

    parser.add_argument(

        "--delay-between-api-calls",

        type=int,

        default=os.getenv("API_DELAY_SECONDS"),

        type=float,

        default=float(os.getenv("API_DELAY_SECONDS") or "0"),

        help="delay between GitLab API calls, in seconds",

    )

    parser.add_argument(

tests/test_butlercfg.py

+1 −1
Original line number Diff line number Diff line
@@ -101,7 +101,7 @@ class TestButlerCfg: 
        assert generate_parser().parse_args(['--pipeline-deletion-limit', '10']).pipeline_deletion_limit == 10



        # delay-between-api-calls

        assert generate_parser().parse_args([]).delay_between_api_calls is None

        assert generate_parser().parse_args([]).delay_between_api_calls == 0.0

        assert generate_parser().parse_args(['--delay-between-api-calls', '10']).delay_between_api_calls == 10



        # pipelines-delete-older-than