Skip to content

fix(deps): update dependency python-gitlab to v3

Sylvain Desbureaux requested to merge renovate/python into main

This MR contains the following updates:

Package Change Age Adoption Passing Confidence
python-gitlab ==2.10.1 -> ==3.12.0 age adoption passing confidence

Release Notes

python-gitlab/python-gitlab

v3.12.0

Compare Source

Feature
  • Add support for SAML group links (#​2367) (1020ce9)
  • groups: Add LDAP link manager and deprecate old API endpoints (3a61f60)
  • groups: Add support for listing ldap_group_links (#​2371) (ad7c8fa)
  • Implement secure files API (d0a0348)
  • ci: Re-Run Tests on MR Comment workflow (034cde3)
  • api: Add support for getting a project's pull mirror details (060cfe1)
  • api: Add support for remote project import from AWS S3 (#​2357) (892281e)
  • api: Add support for remote project import (#​2348) (e5dc72d)
  • api: Add application statistics (6fcf3b6)
Fix
  • cli: Enable debug before doing auth (65abb85)
  • cli: Expose missing mr_default_target_self project attribute (12aea32)
  • Use POST method and return dict in cancel_merge_when_pipeline_succeeds() (#​2350) (bd82d74)
Documentation
  • Use the term "log file" for getting a job log file (9d2b1ad)
  • groups: Describe GitLab.com group creation limitation (9bd433a)
  • api: Pushrules remove saying None is returned when not found (c3600b4)

v3.11.0

Compare Source

Feature
  • build: Officially support Python 3.11 (74f66c7)
  • api: Add support for topics merge API (9a6d197)
Fix
  • Remove project.approvals.set_approvals() method (91f08f0)
  • Use epic id instead of iid for epic notes (97cae38)
  • cli: Handle list response for json/yaml output (9b88132)
  • Intermittent failure in test_merge_request_reset_approvals (3dde36e)
Documentation
  • advanced: Add hint on type narrowing (a404152)
  • Add minimal docs about the enable_debug() method (b4e9ab7)
  • commits: Fix commit create example for binary content (bcc1eb4)
  • readme: Add a basic feature list (b4d53f1)
  • api: Describe use of lower-level methods (b7a6874)
  • api: Describe the list() and all() runners' functions (b6cc3f2)
  • api: Update merge_requests.rst: mr_id to mr_iid (b32234d)

v3.10.0

Compare Source

Feature
  • Add reset_approvals api (88693ff)
  • Add support for deployment approval endpoint (9c9eeb9)
Fix
  • cli: Add missing attributes for creating MRs (1714d0a)
  • cli: Add missing attribute for MR changes (20c46a0)

v3.9.0

Compare Source

Feature
  • Add support for merge_base API (dd4fbd5)

v3.8.1

Compare Source

Fix
  • client: Do not assume user attrs returned for auth() (a07547c)

v3.8.0

Compare Source

Feature
  • client: Warn user on misconfigured URL in auth() (0040b43)
  • Support downloading archive subpaths (cadb0e5)
Fix
  • client: Ensure encoded query params are never duplicated (1398426)
  • Optionally keep user-provided base URL for pagination (#​2149) (e2ea8b8)
Documentation
  • Describe self-revoking personal access tokens (5ea48fc)

v3.7.0

Compare Source

Feature
  • Allow sort/ordering for project releases (b1dd284)
  • cli: Add a custom help formatter (005ba93)
  • Add support for iterations API (194ee01)
  • groups: Add support for shared projects API (66461ba)
  • issues: Add support for issue reorder API (8703324)
  • namespaces: Add support for namespace existence API (4882cb2)
  • Add support for group and project invitations API (7afd340)
  • projects: Add support for project restore API (4794ecc)
  • Add support for filtering jobs by scope (0e1c0dd)
  • Add asdict() and to_json() methods to Gitlab Objects (08ac071)
  • api: Add support for instance-level registry repositories (284d739)
  • groups: Add support for group-level registry repositories (70148c6)
  • Add 'merge_pipelines_enabled' project attribute (fc33c93)
  • Support validating CI lint results (3b1ede4)
  • cli: Add support for global CI lint (3f67c4b)
  • objects: Add Project CI Lint support (b213dd3)
  • Add support for group push rules (b5cdc09)
  • api: Add support for get for a MR approval rule (89c18c6)
Fix
  • Support array types for most resources (d9126cd)
  • Use the [] after key names for array variables in params (1af44ce)
  • runners: Fix listing for /runners/all (c6dd57c)
  • config: Raise error when gitlab id provided but no config section found (1ef7018)
  • config: Raise error when gitlab id provided but no config file found (ac46c1c)
  • Add get_all param (and --get-all) to allow passing all to API (7c71d5d)
  • Results returned by attributes property to show updates (e5affc8)
  • Enable epic notes (5fc3216)
  • cli: Remove irrelevant MR approval rule list filters (0daec5f)
  • Ensure path elements are escaped (5d9c198)
Documentation
  • cli: Showcase use of token scopes (4a6f8d6)
  • projects: Document export with upload to URL (03f5484)
  • Describe fetching existing export status (9c5b8d5)
  • authors: Add John (e2afb84)
  • Document CI Lint usage (d5de4b1)
  • users: Add docs about listing a user's projects (065a1a5)
  • Update return type of pushrules (53cbecc)
  • Describe ROPC flow in place of password authentication (91c17b7)
  • readme: Remove redundant -v that breaks the command (c523e18)

v3.6.0

Compare Source

Feature
  • downloads: Allow streaming downloads access to response iterator (#​1956) (b644721)
  • api: Support head() method for get and list endpoints (ce9216c)
  • api: Implement HEAD method (90635a7)
  • users: Add approve and reject methods to User (f57139d)
  • api: Convert gitlab.const to Enums (c3c6086)
  • Add support for Protected Environments (1dc9d0f)
  • users: Add ban and unban methods (0d44b11)
  • docker: Provide a Debian-based slim image (384031c)
  • Support mutually exclusive attributes and consolidate validation to fix board lists (#​2037) (3fa330c)
  • client: Introduce iterator=True and deprecate as_list=False in list() (cdc6605)
Fix
  • base: Do not fail repr() on lazy objects (1efb123)
  • cli: Project-merge-request-approval-rule (15a242c)
  • cli: Fix project export download for CLI (5d14867)
Documentation
  • api: Add separate section for advanced usage (22ae101)
  • api: Document usage of head() methods (f555bfb)
  • projects: Provide more detailed import examples (8f8611a)
  • projects: Document 404 gotcha with unactivated integrations (522ecff)
  • variables: Instruct users to follow GitLab rules for values (194b6be)
  • api: Stop linking to python-requests.org (49c7e83)
  • api: Fix incorrect docs for merge_request_approvals (#​2094) (5583eaa)
  • api-usage: Add import os in example (2194a44)
  • Drop deprecated setuptools build_sphinx (048d66a)
  • usage: Refer to upsteam docs instead of custom attributes (ae7d3b0)
  • ext: Fix rendering for RequiredOptional dataclass (4d431e5)
  • Documentation updates to reflect addition of mutually exclusive attributes (24b720e)
  • Use as_list=False or all=True in Getting started (de8c6e8)

v3.5.0

Compare Source

Feature
  • objects: Support get project storage endpoint (8867ee5)
  • Display human-readable attribute in repr() if present (6b47c26)
  • ux: Display project.name_with_namespace on project repr (e598762)
Fix
  • cli: Changed default allow_abbrev value to fix arguments collision problem (#​2013) (d68cacf)
  • Duplicate subparsers being added to argparse (f553fd3)
Documentation
  • Update issue example and extend API usage docs (aad71d2)
  • CONTRIBUTING.rst: Fix link to conventional-changelog commit format documentation (2373a4f)
  • Add missing Admin access const value (3e0d4d9)
  • merge_requests: Add new possible merge request state and link to the upstream docs (e660fa8)

v3.4.0

Compare Source

Feature
  • Emit a warning when using a list() method returns max (1339d64)
  • objects: Support getting project/group deploy tokens by id (fcd37fe)
  • user: Support getting user SSH key by id (6f93c05)
  • api: Re-add topic delete endpoint (d1d96bd)
Fix
  • Add ChunkedEncodingError to list of retryable exceptions (7beb20f)
  • Avoid passing redundant arguments to API (3431887)
  • cli: Add missing filters for project commit list (149d244)
  • Add 52x range to retry transient failures and tests (c3ef1b5)
  • Also retry HTTP-based transient errors (3b49e4d)
Documentation
  • api-docs: Docs fix for application scopes (e1ad93d)

v3.3.0

Compare Source

Feature
  • object: Add pipeline test report summary support (a97e0cf)
Fix
  • Support RateLimit-Reset header (4060146)
Documentation
  • Fix typo and incorrect style (2828b10)
  • Add pipeline test report summary support (d78afb3)
  • chore: Include docs .js files in sdist (3010b40)

v3.2.0

Compare Source

Feature
  • merge_request_approvals: Add support for deleting MR approval rules (85a734f)
  • artifacts: Add support for project artifacts delete API (c01c034)
  • mixins: Allow deleting resources without IDs (0717517)
  • objects: Add a complete artifacts manager (c8c2fa7)
Fix
  • services: Use slug for id_attr instead of custom methods (e30f39d)
  • Remove custom delete method for labels (0841a2a)
Documentation
  • Enable gitter chat directly in docs (bd1ecdd)
  • Add delete methods for runners and project artifacts (5e711fd)
  • Add retry_transient infos (bb1f054)
  • Add transient errors retry info (b7a1266)
  • artifacts: Deprecate artifacts() and artifact() methods (64d01ef)
  • Revert "chore: add temporary banner for v3" (#​1864) (7a13b9b)

v3.1.1

Compare Source

Fix
  • cli: Make 'per_page' and 'page' type explicit (d493a5e)
  • cli: Make 'timeout' type explicit (bbb7df5)
  • cli: Allow custom methods in managers (8dfed0c)
  • objects: Make resource access tokens and repos available in CLI (e0a3a41)
Documentation
  • Enhance release docs for CI_JOB_TOKEN usage (5d973de)
  • changelog: Add missing changelog items (01755fb)

v3.1.0

Compare Source

Feature
  • add support for Group Access Token API (c01b7c4)
  • Add support for Groups API method transfer() (0007006)
  • api: Add project.transfer() and deprecate transfer_project() (259668a)
  • api: Return result from SaveMixin.save() (e6258a4)
Fix
  • cli: Add missing list filters for environments (6f64d40)
  • Use url-encoded ID in all paths (12435d7)
  • members: Use new *All objects for *AllManager managers (755e0a3)
  • api: Services: add missing lazy parameter (888f332)
  • broken URL for FAQ about attribute-error-list (1863f30)
  • remove default arguments for mergerequests.merge() (8e589c4)
  • remove custom URL encoding (3d49e5e)
Documentation
  • cli: make examples more easily navigable by generating TOC (f33c523)
  • update project access token API reference link (73ae955)

v3.0.0

Compare Source

Feature
  • docker: Remove custom entrypoint from image (80754a1)
  • cli: Allow options from args and environment variables (ca58008)
  • api: Support file format for repository archive (83dcabf)
  • Add support for squash_option in Projects (a246ce8)
  • cli: Do not require config file to run CLI (92a893b)
  • api: Add support for Topics API (e7559bf)
  • Add delete on package_file object (124667b)
  • Add support for projects.groups.list() (68ff595)
  • api: Add support for epic notes (7f4edb5)
  • Remove support for Python 3.6, require 3.7 or higher (414009d)
  • api: Add project milestone promotion (f068520)
  • api: Add merge trains (fd73a73)
  • api: Add merge request approval state (f41b093)
  • api: Add project label promotion (6d7c88a)
  • objects: Support delete package files API (4518046)
  • objects: List starred projects of a user (47a5606)
  • build: Officially support and test python 3.10 (c042ddc)
  • objects: Support Create and Revoke personal access token API (e19314d)
  • Default to gitlab.com if no URL given (8236281)
  • Allow global retry_transient_errors setup (3b1d3a4)
Fix
  • Handle situation where GitLab does not return values (cb824a4)
  • Stop encoding '.' to '%2E' (702e41d)
  • build: Do not include docs in wheel package (68a97ce)
  • api: Delete invalid 'project-runner get' command (#​1628) (905781b)
  • api: Replace deprecated attribute in delete_in_bulk() (#​1536) (c59fbdb)
  • objects: Rename confusing to_project_id argument (ce4bc0d)
  • Raise error if there is a 301/302 redirection (d56a434)
  • build: Do not package tests in wheel (969dccc)
Breaking
  • The gitlab CLI will now accept CLI arguments and environment variables for its global options in addition to configuration file options. This may change behavior for some workflows such as running inside GitLab CI and with certain environment variables configured. (ca58008)
  • stop encoding '.' to '%2E'. This could potentially be a breaking change for users who have incorrectly configured GitLab servers which don't handle period '.' characters correctly. (702e41d)
  • A config file is no longer needed to run the CLI. python-gitlab will default to https://gitlab.com with no authentication if there is no config file provided. python-gitlab will now also only look for configuration in the provided PYTHON_GITLAB_CFG path, instead of merging it with user- and system-wide config files. If the environment variable is defined and the file cannot be opened, python-gitlab will now explicitly fail. (92a893b)
  • As of python-gitlab 3.0.0, Python 3.6 is no longer supported. Python 3.7 or higher is required. (414009d)
  • As of python-gitlab 3.0.0, the default branch for development has changed from master to main. (545f8ed)
  • remove deprecated branch protect methods in favor of the more complete protected branches API. (9656a16)
  • The deprecated name_regex attribute has been removed in favor of name_regex_delete. (see gitlab-org/gitlab@ce99813c) (c59fbdb)
  • rename confusing to_project_id argument in transfer_project to project_id (--project-id in CLI). This is used for the source project, not for the target namespace. (ce4bc0d)
  • remove deprecated constants defined in gitlab.v4.objects, and use only gitlab.const module (3f320af)
  • remove deprecated tag release API. This was removed in GitLab 14.0 (2b8a94a)
  • remove deprecated project.issuesstatistics in favor of project.issues_statistics (ca7777e)
  • remove deprecated members.all() method in favor of members_all.list() (4d7b848)
  • remove deprecated pipelines() methods in favor of pipelines.list() (c4f5ec6)
  • python-gitlab will now default to gitlab.com if no URL is given (8236281)
  • raise error if there is a 301/302 redirection (d56a434)
Documentation
  • Switch to Furo and refresh introduction pages (ee6b024)
  • Correct documentation for updating discussion note (ee66f4a)
  • Rename documentation files to match names of code files (ee3f865)
  • project: Remove redundant encoding parameter (fed613f)
  • Use annotations for return types (79e785e)
  • Update docs to use gitlab.const for constants (b3b0b5f)
  • Only use type annotations for documentation (b7dde0d)
  • Add links to the GitLab API docs (e3b5d27)
  • Fix API delete key example (b31bb05)
  • pipelines: Document take_ownership method (69461f6)
  • api: Document the update method for project variables (7992911)
  • api: Clarify job token usage with auth() (3f423ef)
  • Fix a few typos (7ea4ddc)
  • Consolidate changelogs and remove v3 API docs (90da8ba)
  • Correct documented return type (acabf63)

Configuration

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

🚦 Automerge: Enabled.

♻ 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.

Merge request reports