v3.4.0

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

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

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

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

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

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 https://gitlab.com/gitlab-org/gitlab/-/commit/ce99813cf54) (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: Clarif...

v2.10.1

Fix

• mixins: Improve deprecation warning (57e0187)
• deps: Upgrade requests to 2.25.0 (see CVE-2021-33503) (ce995b2)

Documentation

• mergequests: Gl.mergequests.list documentation was missleading (5b5a7bc)

v2.10.0

Feature

• api: Add merge_ref for merge requests (1e24ab2)
• api: Add name_regex_keep attribute in delete_in_bulk() (e49ff3f)

Fix

• api: Do not require Release name for creation (98cd03b)

Documentation

• readme: Move contributing docs to CONTRIBUTING.rst (edf49a3)
• Add example for mr.merge_ref (b30b8ac)
• project: Add example on getting a single project using name with namespace (ef16a97)

v2.9.0

Feature

• release: Allow to update release (b4c4787)
• api: Add group hooks (4a7e9b8)
• api: Remove responsibility for API inconsistencies for MR reviewers (3d985ee)
• api: Add MR pipeline manager in favor of pipelines() method (954357c)
• api: Add support for creating/editing reviewers in project merge requests (676d1f6)

Documentation

• tags: Remove deprecated functions (1b1a827)
• release: Add update example (6254a5f)
• Make Gitlab class usable for intersphinx (8753add)

v2.8.0

Feature

• Add keys endpoint (a81525a)
• objects: Add support for Group wikis (#1484) (74f5e62)
• objects: Add support for generic packages API (79d88bd)
• api: Add deployment mergerequests interface (fbbc0d4)
• objects: Support all issues statistics endpoints (f731707)
• objects: Add support for descendant groups API (1b70580)
• objects: Add pipeline test report support (ee9f96e)
• objects: Add support for billable members (fb0b083)
• Add feature to get inherited member for project/group (e444b39)
• Add code owner approval as attribute (fdc46ba)
• Indicate that we are a typed package (e4421ca)
• Add support for lists of integers to ListAttribute (115938b)

Fix

• Catch invalid type used to initialize RESTObject (c7bcc25)
• Functional project service test (#1500) (093db9d)
• Ensure kwargs are passed appropriately for ObjectDeleteMixin (4e690c2)
• cli: Add missing list filter for jobs (b3d1c26)
• Change mr.merge() to use 'post_data' (cb6a3c6)
• cli: Fix parsing CLI objects to classnames (4252070)
• objects: Return server data in cancel/retry methods (9fed061)
• objects: Add missing group attributes (d20ff4f)
• objects: Allow lists for filters for in all objects (603a351)
• Iids not working as a list in projects.issues.list() (45f806c)
• Add a check to ensure the MRO is correct (565d548)

Documentation

• Fix typo in http_delete docstring (5226f09)
• api: Add behavior in local attributes when updating objects (38f65e8)
• Fail on warnings during sphinx build (cbd4d52)