v4.1.1

v4.1.1 (2023-11-03)

Chore

• chore(ci): add release id to workflow step (9270e10)

• chore(deps): update all non-major dependencies (32954fb)

Documentation

• docs(users): add missing comma in v4 API create runner examples

The examples which show usage of new runner registration api endpoint
are missing commas. This change adds the missing commas. (b1b2edf)

Fix

• fix(build): include py.typed in dists (b928639)

v4.1.0

Feature

• add Merge Request merge_status and detailed_merge_status values as constants (e18a424)

v4.0.0

Feature

• client: mask tokens by default when logging (1611d78)
• api: add ProjectPackagePipeline
• feat: officially support Python 3.12 (2a69c0e)
• packages: Allow uploading bytes and files
• feat: Use requests AuthBase classes (5f46cfd)
• api: add support for job token scope settings (59d6a88)
• api: support project remote mirror deletion (d900910)
• api: add optional GET attrs for /projects/:id/ci/lint (40a102d)
• api: add support for new runner creation API (#2635)
• releases: Add support for direct_asset_path
• feat: Added iteration to issue and group filters (8d2d297)

Fix

• cli: add _from_parent_attrs to user-project manager (#2558) (016d90c)
• cli: fix action display in --help when there are few actions
• client: support empty 204 responses in http_patch (e15349c)
• snippets: allow passing list of files (31c3c5e)

Documentation

• correct error with back-ticks (#2653)
• access_token: adopt token docs to 16.1
• files: fix minor typo in variable declaration (118ce42)

Breaking

• python-gitlab now explicitly passes auth to requests, meaning
  it will only read netrc credentials if no token is provided, fixing a bug where
  netrc credentials took precedence over OAuth tokens. This also affects the CLI,
  where all environment variables now take precedence over netrc files. (45b8930)
• python-gitlab now stores metadata in pyproject.toml
  as per PEP 621, with setup.py removed. pip version v21.1 or higher is
  required if you want to perform an editable install. (71fca8c)
• Constants defined in gitlab.const can no longer be imported globally from gitlab.
  Import them from gitlab.const instead. (e4a1f6e)
• Support for the deprecated as_list argument in
  list() calls has been removed. Use iterator instead. (9b6d89e)
• The deprecated lint() method is no longer available.
  Use ci_lint.create() instead. (0b17a2d)
• The deprecated project.artifact() method is no longer available.
  Use project.artifacts.raw() instead. (90134c9)
• The deprecated project.artifacts() method is no longer available.
  Use project.artifacts.download() instead. (42639f3)
• The deprecated group.add_ldap_group_link() and group.delete_ldap_group_link()
  methods are no longer available. Use group.ldap_group_links.create() and group.ldap_group_links.delete()
  instead. (5c8b7c1)
• The deprecated project.transfer_project() method is no longer available.
  Use project.transfer() instead. (27ed490)
• The --all option is no longer available in the CLI. Use --get-all instead. (e9d48cf)
• As of python-gitlab 4.0.0, Python 3.7 is no longer
  supported. Python 3.8 or higher is required. (058d5a5)

v3.15.0

Feature

• Add support for select="package_file" in package upload (3a49f09)
• api: Add support for events scope parameter (348f56e)
• Usernames support for MR approvals (a2b8c8c)

Documentation

• Remove exclusive EE about issue links (e0f6f18)

v3.14.0

Feature

• projects: Allow importing additional items from GitHub (ce84f2e)
• objects: Support fetching PATs via id or self endpoint (19b38bd)
• Add resource_weight_event for ProjectIssue (6e5ef55)
• backends: Use PEP544 protocols for structural subtyping (#2442) (4afeaff)
• client: Add http_patch method (#2471) (f711d9e)
• cli: Add setting of allow_force_push for protected branch (929e07d)

Fix

• cli: Warn user when no fields are displayed (8bf53c8)
• client: Properly parse content-type when charset is present (76063c3)
• Support int for parent_id in import_group (90f96ac)
• cli: Add ability to escape at-prefixed parameter (#2513) (4f7c784)
• cli: Display items when iterator is returned (33a04e7)
• Typo fixed in docs (ee5f444)

Documentation

• objects: Fix typo in pipeline schedules (3057f45)
• advanced: Clarify netrc, proxy behavior with requests (1da7c53)
• Fix update badge behaviour (3d7ca1c)
• advanced: Fix typo in Gitlab examples (1992790)

v3.13.0

Feature

• group: Add support for group restore API (9322db6)
• client: Automatically retry on HTTP 409 Resource lock (dced76a)
• api: Add support for bulk imports API (043de2d)
• api: Add support for resource groups (5f8b8f5)
• api: Support listing pipelines triggered by pipeline schedules (865fa41)
• Allow filtering pipelines by source (b6c0872)
• client: Bootstrap the http backends concept (#2391) (91a665f)
• Add resource iteration events (see https://docs.gitlab.com/ee/api/resource_iteration_events.html) (ef5feb4)
• Allow passing kwargs to Gitlab class when instantiating with from_config (#2392) (e88d34e)
• Add keep_base_url when getting configuration from file (50a0301)

Fix

• client: Regression - do not automatically get_next if page=# and (585e3a8)
• Change return value to "None" in case getattr returns None to prevent error (3f86d36)
• deps: Bump requests-toolbelt to fix deprecation warning (faf842e)
• Use the ProjectIterationManager within the Project object (44f05dc)
• api: Make description optional for releases (5579750)

Documentation

• faq: Describe and group common errors (4c9a072)

v3.12.0

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 PR 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

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

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

Feature

• Add support for merge_base API (dd4fbd5)