Skip to content

fix(deps): update dependency python-gitlab to v5 - autoclosed

renovate requested to merge renovate/python-gitlab-5.x into master

This MR contains the following updates:

Package Type Update Change
python-gitlab (changelog) project.dependencies major <5.0.0,>=4.6.0 -> <5.7.0,>=5.6.0

Release Notes

python-gitlab/python-gitlab (python-gitlab)

v5.6.0

Compare Source

Features
  • group: Add support for group level MR approval rules (304bdd0)

v5.5.0

Compare Source

Chores

  • Add deprecation warning for mirror_pull functions (7f6fd5c)

  • Relax typing constraints for response action (f430078)

  • tests: Catch deprecation warnings (0c1af08)

Documentation

  • Add usage of pull mirror (9b374b2)

  • Remove old pull mirror implementation (9e18672)

Features

  • functional: Add pull mirror test (3b31ade)

  • projects: Add pull mirror class (2411bff)

  • unit: Add pull mirror tests (5c11203)

v5.4.0

Compare Source

Bug Fixes
  • api: Make type ignores more specific where possible (e3cb806)

Instead of using absolute ignore # type: ignore use a more specific ignores like # type: ignore[override]. This might help in the future where a new bug might be introduced and get ignored by a general ignore comment but not a more specific one.

Signed-off-by: Igor Ponomarev igor.ponomarev@collabora.com

  • api: Return the new commit when calling cherry_pick (de29503)

  • files: Add optional ref parameter for cli project-file raw (#​3032) (22f03bd)

The ef parameter was removed in python-gitlab v4.8.0. This will add ef back as an optional parameter for the project-file raw cli command.

Chores

  • Fix missing space in deprecation message (ba75c31)

  • Fix pytest deprecation (95db680)

pytest has changed the function argument name to start_path

  • Fix warning being generated (0eb5eb0)

The CI shows a warning. Use get_all=False to resolve issue.

  • Resolve DeprecationWarning message in CI run (accd5aa)

Catch the DeprecationWarning in our test, as we expect it.

  • ci: Set a 30 minute timeout for 'functional' tests (e8d6953)

Currently the functional API test takes around 17 minutes to run. And the functional CLI test takes around 12 minutes to run.

Occasionally a job gets stuck and will sit until the default 360 minutes job timeout occurs.

Now have a 30 minute timeout for the 'functional' tests.

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update gitlab/gitlab-ee docker tag to v17.7.1-ee.0 (#​3082, 1e95944)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update mypy to 1.14 and resolve issues (671e711)

mypy 1.14 has a change to Enum Membership Semantics: https://mypy.readthedocs.io/en/latest/changelog.html

Resolve the issues with Enum and typing, and update mypy to 1.14

  • test: Prevent 'job_with_artifact' fixture running forever (e4673d8)

Previously the 'job_with_artifact' fixture could run forever. Now give it up to 60 seconds to complete before failing.

Continuous Integration
  • Use gitlab-runner:v17.7.1 for the CI (2dda9dc)

The latest gitlab-runner image does not have the gitlab-runner user and it causes our tests to fail.

Closes: #​3091

Features
  • api: Add argument that appends extra HTTP headers to a request (fb07b5c)

Currently the only way to manipulate the headers for a request is to use Gitlab.headers attribute. However, this makes it very concurrently unsafe because the Gitlab object can be shared between multiple requests at the same time.

Instead add a new keyword argument extra_headers which will update the headers dictionary with new values just before the request is sent.

For example, this can be used to download a part of a artifacts file using the Range header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests

Signed-off-by: Igor Ponomarev igor.ponomarev@collabora.com

  • api: Add support for external status check (175b355)

  • api: Narrow down return type of download methods using typing.overload (44fd9dc)

Currently the download methods such as ProjectJob.artifacts have return type set to Optional[Union[bytes, Iterator[Any]]] which means they return either None or bytes or Iterator[Any].

However, the actual return type is determined by the passed streamed and iterator arguments. Using @typing.overload decorator it is possible to return a single type based on the passed arguments.

Add overloads in the following order to all download methods:

  1. If streamed=False and iterator=False return bytes. This is the default argument values therefore it should be first as it will be used to lookup default arguments. 2. If iterator=True return Iterator[Any]. This can be combined with both streamed=True and streamed=False. 3. If streamed=True and iterator=False return None. In this case action argument can be set to a callable that accepts bytes.

Signed-off-by: Igor Ponomarev igor.ponomarev@collabora.com

  • api: Narrow down return type of ProjectFileManager.raw using typing.overload (36d9b24)

This is equivalent to the changes in 44fd9dc but for ProjectFileManager.raw method that I must have missed in the original commit.

Signed-off-by: Igor Ponomarev igor.ponomarev@collabora.com

v5.3.1

Compare Source

Bug Fixes

  • api: Allow configuration of keep_base_url from file (f4f7d7a)

  • registry-protection: Fix api url (8c1aaa3)

See: https://docs.gitlab.com/ee/api/container_repository_protection_rules.html#list-container-repository-protection-rules

Chores

  • Bump to 5.3.1 (912e1a0)

  • deps: Update dependency jinja2 to v3.1.5 [security] (01d4194)

v5.3.0

Compare Source

Chores
  • deps: Update gitlab/gitlab-ee docker tag to v17.7.0-ee.0 (#​3070, 62b7eb7)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • renovate: Update httpx and respx again (aa07449)
Features
  • api: Support the new registry protection rule endpoint (40af1c8)

v5.2.0

Compare Source

Chores

  • deps: Update all non-major dependencies (1e02f23)

  • deps: Update all non-major dependencies (6532e8c)

  • deps: Update all non-major dependencies (8046387)

  • deps: Update codecov/codecov-action action to v5 (735efff)

  • deps: Update dependency commitizen to v4 (9306362)

  • deps: Update gitlab/gitlab-ee docker tag to v17.6.1-ee.0 (#​3053, f2992ae)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update gitlab/gitlab-ee docker tag to v17.6.2-ee.0 (#​3065, db0db26)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update pre-commit hook commitizen-tools/commitizen to v4 (a8518f1)

  • docs: Fix CHANGELOG tracebacks codeblocks (9fe372a)

With v5.1.0 CHANGELOG.md was updated that mangled v1.10.0 triple backtick codeblock Traceback output that made sphinx fail [1] with a non-zero return code.

The resulting docs appears to be processes as text after the failing line [2]. While reviewing other backtick codeblocks fix v1.8.0 [3] to the original traceback.

[1] https://github.com/python-gitlab/python-gitlab/actions/runs/12060608158/job/33631303063#step:5:204 [2] https://python-gitlab.readthedocs.io/en/v5.1.0/changelog.html#v1-10-0-2019-07-22 [3] https://python-gitlab.readthedocs.io/en/v5.0.0/changelog.html#id258

  • renovate: Pin httpx until respx is fixed (b70830d)
Documentation
  • api-usage: Fix link to Gitlab REST API Authentication Docs (#​3059, f460d95)
Features
  • feat(api): Added project template classes to templates.py * feat(api): Added project template managers to Project in project.py * docs(merge_requests): Add example of creating mr with description template * test(templates): Added unit tests for templates * docs(templates): added section for project templates
  • graphql: Add async client (288f39c)

v5.1.0

Compare Source

Chores

  • deps: Update all non-major dependencies (9061647)

  • deps: Update all non-major dependencies (62da12a)

  • deps: Update all non-major dependencies (7e62136)

  • deps: Update all non-major dependencies (d4b52e7)

  • deps: Update all non-major dependencies (541a7e3)

  • deps: Update dependency pytest-cov to v6 (ffa88b3)

  • deps: Update gitlab/gitlab-ee docker tag to v17.5.1-ee.0 (8111f49)

  • deps: Update gitlab/gitlab-ee docker tag to v17.5.2-ee.0 (#​3041, d39129b)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update gitlab/gitlab-ee docker tag to v17.6.0-ee.0 (#​3044, 79113d9)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v39 (11458e0)
Features

  • api: Get single project approval rule (029695d)

  • api: Support list and delete for group service accounts (#​2963, 499243b)

  • cli: Enable token rotation via CLI (0cb8171)

  • const: Add new Planner role to access levels (bdc8852)

  • files: Add support for more optional flags (f51cd52)

GitLab's Repository Files API supports additional flags that weren't implemented before. Notably, the "start_branch" flag is particularly useful, as previously one had to use the "project-branch" command alongside "project-file" to add a file on a separate branch.

[1] https://docs.gitlab.com/ee/api/repository_files.html

v5.0.0

Compare Source

Bug Fixes
  • api: Set _repr_attr for project approval rules to name attr (#​3011, 1a68f1c)

Co-authored-by: Patrick Evans patrick.evans@gehealthcare.com

Chores

Mark that Python 3.13 is supported.

Use Python 3.13 for the Mac and Windows tests.

Also remove the 'py38' tox environment. We no longer support Python 3.8.

  • Add testing of Python 3.14 (14d2a82)

Also fix annotations not working in Python 3.14 by using the annotation on the 'class' instead of on the 'instance'

Closes: #​3013

python-gitlab hasn't supported the GitLab v3 API since 2018. The last version of python-gitlab to support it was v1.4

Support was removed in:

commit fe89b94 Author: Gauvain Pocentek gauvain@pocentek.net

Date: Sat May 19 17:10:08 2018 +0200

Drop API v3 support

Drop the code, the tests, and update the documentation.

  • deps: Update all non-major dependencies (1e4326b)

  • deps: Update all non-major dependencies (b3834dc)

  • deps: Update dependency ubuntu to v24 (6fda15d)

  • deps: Update gitlab/gitlab-ee docker tag to v17.4.2-ee.0 (1cdfe40)

  • deps: Update gitlab/gitlab-ee docker tag to v17.5.0-ee.0 (c02a392)

Documentation
Features

Python 3.8 is End-of-Life (EOL) as of 2024-10 as stated in https://devguide.python.org/versions/ and https://peps.python.org/pep-0569/#lifespan

By dropping support for Python 3.8 and requiring Python 3.9 or higher it allows python-gitlab to take advantage of new features in Python 3.9, which are documented at: https://docs.python.org/3/whatsnew/3.9.html

Closes: #​2968

BREAKING CHANGE: As of python-gitlab 5.0.0, Python 3.8 is no longer supported. Python 3.9 or higher is required.

Testing
  • Add test for to_json() method (f4bfe19)

This should get us to 100% test coverage on gitlab/base.py

BREAKING CHANGES
  • As of python-gitlab 5.0.0, Python 3.8 is no longer supported. Python 3.9 or higher is required.

v4.13.0

Compare Source

Chores

  • deps: Update all non-major dependencies (c3efb37)

  • deps: Update dependency pre-commit to v4 (#​3008, 5c27546)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

Features
  • api: Add support for project Pages API (0ee0e02)

v4.12.2

Compare Source

Bug Fixes

When an error occurs, raise GitlabHeadError in project.files.head() method.

Closes: #​3004

v4.12.1

Compare Source

Bug Fixes

  • ci: Do not rely on GitLab.com runner arch variables (#​3003, c848d12)

  • files: Correctly raise GitlabGetError in get method (190ec89)

Chores

Co-authored-by: renovate[bot] <29139614+renovate[bot]@​users.noreply.github.com>

  • deps: Update gitlab/gitlab-ee docker tag to v17.4.1-ee.0 (64eed5d)

v4.12.0

Compare Source

Bug Fixes
  • fix(api): head requests for projectfilemanager

Co-authored-by: Patrick Evans patrick.evans@gehealthcare.com

Co-authored-by: Nejc Habjan hab.nejc@gmail.com

Chores

pylint 3.3.1 appears to have added "too-many-positional-arguments" check with a value of 5.

I don't disagree with this, but we have many functions which exceed this value. We might think about converting some of positional arguments over to keyword arguments in the future. But that is for another time.

For now disable the check across the project.

  • deps: Update all non-major dependencies (ae132e7)

  • deps: Update all non-major dependencies (10ee58a)

  • deps: Update dependency types-setuptools to v75 (a2ab54c)

  • deps: Update gitlab/gitlab-ee docker tag to v17.3.2-ee.0 (5cd1ab2)

  • deps: Update gitlab/gitlab-ee docker tag to v17.4.0-ee.0 (8601808)

Features

v4.11.1

Compare Source

Bug Fixes
  • client: Ensure type evaluations are postponed (b41b2de)

v4.11.0

Compare Source

Chores

  • deps: Update all non-major dependencies (fac8bf9)

  • deps: Update all non-major dependencies (88c7529)

  • deps: Update dependency types-setuptools to v74 (bdfaddb)

  • pre-commit: Add deps (fe5e608)

Documentation
  • objects: Fix typo in get latest pipeline (b9f5c12)
Features

  • Add a minimal GraphQL client (d6b1b0a)

  • api: Add exclusive GET attrs for /groups/:id/members (d44ddd2)

  • api: Add exclusive GET attrs for /projects/:id/members (e637808)

  • client: Add retry handling to GraphQL client (8898c38)

  • client: Make retries configurable in GraphQL (145870e)

Refactoring
  • client: Move retry logic into utility (3235c48)

v4.10.0

Compare Source

Chores

  • deps: Update all non-major dependencies (2ade0d9)

  • deps: Update all non-major dependencies (0578bf0)

  • deps: Update all non-major dependencies (31786a6)

  • deps: Update dependency myst-parser to v4 (930d4a2)

  • deps: Update dependency sphinx to v8 (cb65ffb)

  • deps: Update dependency types-setuptools to v73 (d55c045)

  • deps: Update gitlab/gitlab-ee docker tag to v17.2.2-ee.0 (b2275f7)

  • deps: Update gitlab/gitlab-ee docker tag to v17.3.0-ee.0 (e5a46f5)

  • deps: Update gitlab/gitlab-ee docker tag to v17.3.1-ee.0 (3fdd130)

  • deps: Update python-semantic-release/upload-to-gh-release digest to 17c75b7 (12caaa4)

  • release: Track tags for renovate (d600444)

Documentation
  • faq: Correct the attribute fetching example (43a16ac)

There is an example about object attributes in the FAQ. It shows how to properly fetch all attributes of all projects, by using list() followed by a get(id) call.

Unfortunately this example used a wrong variable name, which caused it not to work and which could have made it slightly confusing to readers. This commit fixes that, by changing the variable name.

Now the example uses one variable for two Python objects. As they correspond to the same GitLab object and the intended behavior is to obtain that very object, just with all attributes, this is fine and is probably what readers will find most useful in this context.

Features
  • api: Project/group hook test triggering (9353f54)

Add the ability to trigger tests of project and group hooks.

Fixes #​2924

Testing
  • cli: Allow up to 30 seconds for a project export (bdc155b)

Before we allowed a maximum of around 15 seconds for the project-export. Often times the CI was failing with this value.

Change it to a maximum of around 30 seconds.

v4.9.0

Compare Source

Chores
  • ci: Make pre-commit check happy (67370d8)

pre-commit incorrectly wants double back-quotes inside the code section. Rather than fight it, just use single quotes.

  • deps: Update all non-major dependencies (f95ca26)

  • deps: Update all non-major dependencies (7adc86b)

  • deps: Update all non-major dependencies (e820db0)

  • deps: Update dependency types-setuptools to v71 (d6a7dba)

  • deps: Update gitlab/gitlab-ee docker tag to v17.2.1-ee.0 (d13a656)

  • deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v38 (f13968b)

  • deps: Update python-semantic-release/upload-to-gh-release digest to 0dcddac (eb5c6f7)

  • deps: Update python-semantic-release/upload-to-gh-release digest to e2355e1 (eb18552)

Features
  • snippets: Add support for listing all instance snippets (64ae61e)

v4.8.0

Compare Source

Bug Fixes
  • Have participants() method use http_list() (d065275)

Previously it was using http_get() but the participants API returns a list of participants. Also by using this then we will warn if only a subset of the participants are returned.

Closes: #​2913

  • Issues closed_by()/related_merge_requests() use http_list (de2e4dd)

The closed_by() and related_merge_requests() API calls return lists. So use the http_list() method.

This will also warn the user if only a subset of the data is returned.

  • cli: Generate UserWarning if list does not return all entries (e5a4379)

Previously in the CLI, calls to list() would have get_all=False by default. Therefore hiding the fact that not all items are being returned if there were more than 20 items.

Added --no-get-all option to list actions. Along with the already existing --get-all.

Closes: #​2900

  • files: Cr: add explicit comparison to None (51d8f88)

Co-authored-by: Nejc Habjan hab.nejc@gmail.com

  • files: Make ref parameter optional in get raw file api (00640ac)

The ref parameter was made optional in gitlab v13.11.0.

Chores
  • Add show_caller argument to utils.warn() (7d04315)

This allows us to not add the caller's location to the UserWarning message.

  • Use correct type-hint for die() (9358640)

  • ci: Specify name of "stale" label (44f62c4)

Saw the following error in the log: [#​2618] Removing the label "Stale" from this issue... ##[error][#​2618] Error when removing the label: "Label does not exist"

My theory is that the case doesn't match ("Stale" != "stale") and that is why it failed. Our label is "stale" so update this to match. Thought of changing the label name on GitHub but then would also require a change here to the "any-of-labels". So it seemed simpler to just change it here.

It is confusing though that it detected the label "stale", but then couldn't delete it.

  • ci: Stale: allow issues/MRs that have stale label to be closed (2ab88b2)

If a stale label is manually applied, allow the issue or MR to be closed by the stale job.

Previously it would require the stale label and to also have one of 'need info' or 'Waiting for response' labels added.

  • ci: Use codecov token when available (b74a6fb)

  • deps: Update all non-major dependencies (4a2b213)

  • deps: Update all non-major dependencies (0f59069)

  • deps: Update all non-major dependencies (cf87226)

  • deps: Update gitlab/gitlab-ee docker tag to v17.1.1-ee.0 (5e98510)

  • deps: Update gitlab/gitlab-ee docker tag to v17.1.2-ee.0 (6fedfa5)

  • deps: Update python-semantic-release/upload-to-gh-release digest to c7c3b69 (23393fa)

  • deps: Update python-semantic-release/upload-to-gh-release digest to fe6cc89 (3f3ad80)

Documentation
  • Document how to use sudo if modifying an object (d509da6)

Add a warning about using sudo when saving.

Give an example of how to get an object, modify it, and then save it using sudo

Closes: #​532

  • Variables: add note about filter for updating (c378817)

Add a note about using filter when updating a variable.

Closes: #​2835

Closes: #​1387

Closes: #​1125

Features

  • api: Add support for commit sequence (1f97be2)

  • api: Add support for container registry protection rules (6d31649)

  • api: Add support for package protection rules (6b37811)

  • api: Add support for project cluster agents (32dbc6f)

Refactoring
  • package_protection_rules: Add missing attributes (c307dd2)
Testing

  • files: Omit optional ref parameter in test case (9cb3396)

  • files: Test with and without ref parameter in test case (f316b46)

  • fixtures: Remove deprecated config option (2156949)

  • registry: Disable functional tests for unavailable endpoints (ee393a1)

v4.7.0

Compare Source

Bug Fixes
  • Add ability to add help to custom_actions (9acd2d2)

Now when registering a custom_action can add help text if desired.

Also delete the VerticalHelpFormatter as no longer needed. When the help value is set to None or some other value, the actions will get printed vertically. Before when the help value was not set the actions would all get put onto one line.

Chores
  • Add a help message for gitlab project-key enable (1291dbb)

Add some help text for gitlab project-key enable. This both adds help text and shows how to use the new help feature.

Example:

$ gitlab project-key --help usage: gitlab project-key [-h] {list,get,create,update,delete,enable} ...

options: -h, --help show this help message and exit

action: {list,get,create,update,delete,enable} Action to execute on the GitLab resource. list List the GitLab resources get Get a GitLab resource create Create a GitLab resource update Update a GitLab resource delete Delete a GitLab resource enable Enable a deploy key for the project

  • Sort CLI behavior-related args to remove (9b4b0ef)

Sort the list of CLI behavior-related args that are to be removed.

  • deps: Update all non-major dependencies (88de2f0)

  • deps: Update all non-major dependencies (a510f43)

  • deps: Update all non-major dependencies (d4fdf90)

  • deps: Update all non-major dependencies (d5de288)

  • deps: Update dependency types-setuptools to v70 (7767514)

  • deps: Update gitlab/gitlab-ee docker tag to v17.0.1-ee.0 (df0ff4c)

  • deps: Update gitlab/gitlab-ee docker tag to v17.0.2-ee.0 (51779c6)

  • deps: Update python-semantic-release/upload-to-gh-release digest to 477a404 (02a551d)

  • deps: Update python-semantic-release/upload-to-gh-release digest to 6b7558f (fd0f0b0)

Features
  • Add --no-mask-credentials CLI argument (18aa1fc)

This gives the ability to not mask credentials when using the --debug argument.

  • api: Add support for latest pipeline (635f5a7)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited by renovate

Merge request reports