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)

v2.7.1

• fix(files): do not url-encode file paths twice

v2.7.0

Bug Fixes

• update user's bool data and avatar (3ba27ff)
• argument type was not a tuple as expected (062f8f6)
• correct some type-hints in gitlab/mixins.py (8bd3124)
• only append kwargs as query parameters (b9ecc9a)
• only add query_parameters to GitlabList once (1386)
• checking if RESTManager._from_parent_attrs is set (8224b40)
• handling config value in _get_values_from_helper (9dfb4cd)
• let the homedir be expanded in path of helper (fc7387a)
• make secret helper more user friendly (fc2798f)
• linting issues and test (b04dd2c)
• handle tags like debian/2%2.6-21 as identifiers (b4dac5c)
• remove duplicate class definitions in v4/objects/users.py (7c4e625)
• wrong variable name (15ec41c)
• tox pep8 target, so that it can run (f518e87)
• undefined name errors (48ec9e0)
• extend wait timeout for test_delete_user() (19fde8e)
• test_update_group() dependency on ordering (e78a8d6)
• honor parameter value passed (c2f8f0e)
• objects: add single get endpoint for instance audit events (c3f0a6f)
• types: prevent dir from producing duplicates (5bf7525)

Features

• add ProjectPackageFile (#1372)
• add option to add a helper to lookup token (8ecf559)
• add project audit endpoint (6660dbe)
• add personal access token API (2bb16fa)
• add import from bitbucket server (ff3013a)
• api,cli: make user agent configurable (4bb201b)
• issues: add missing get verb to IssueManager (f78ebe0)
• objects:
  • add support for resource state events API (d4799c4)
  • add support for group audit events API (2a0fbdf)
  • add Release Links API support (28d7518)
• projects: add project access token api (1becef0)
• users: add follow/unfollow API (e456869)

Documentation

• correct ProjectFile.decode() documentation (b180baf)
• update doc for token helper (3ac6fa1)
• better real life token lookup example (9ef8311)

v2.6.0

Features

• support multipart uploads (2fa3004)
• add MINIMAL_ACCESS constant (49eb3ca)
• unit tests added (f37ebf5)
• added support for pipeline bridges (05cbdc2)
• adds support for project merge request approval rules (#1199) (c6fbf39)
• api:
  • added wip filter param for merge requests (d6078f8)
  • added wip filter param for merge requests (aa6e80d)
  • add support for user identity provider deletion (e78e121)
• tests: test label getter (a41af90)

Bug Fixes

• docs changed using the consts (650b65c)
• typo (9baa905)
• api:
  • use RetrieveMixin for ProjectLabelManager (1a14395)
  • add missing runner access_level param (92669f2)
• base: really refresh object (e1e0d8c), closes (#1155)
• cli:
  • write binary data to stdout buffer (0733ec6)
  • add missing args for project lists (c73e237)

v2.5.0

Features

• add support to resource milestone events (88f8cc7), closes #1154
• add share/unshare group with group (7c6e541)
• add support for instance variables (4492fc4)
• add support for Packages API (71495d1)
• add endpoint for latest ref artifacts (b7a07fc)

Bug Fixes

• wrong reconfirmation parameter when updating user's email (b5c267e)
• tests fail when using REUSE_CONTAINER option (0078f899, closes #1146
• implement Gitlab's behavior change for owned=True (9977799)

v2.4.0

Bug Fixes

• do not check if kwargs is none (a349b90)
• make query kwargs consistent between call in init and next (72ffa01)
• pass kwargs to subsequent queries in gitlab list (1d011ac)
• merge: parse arguments as query_data (878098b)

Features

• add NO_ACCESS const (dab4d0a)
• add masked parameter for variables command (b6339bf)