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)

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

• Add Python 3.13 as supported (#3012, b565e78)

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

• Remove "v3" question from issue template (#3017, 482f2fe)

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

• users: Update Gitlab docs links (#3022, 3739b5d)

Features

• Remove support for Python 3.8, require 3.9 or higher (#3005, 9734ad4)

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.

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)

Bug Fixes

• Raise GitlabHeadError in project.files.head() method (#3006, 9bf26df)

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

Closes: #3004

Bug Fixes

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

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

Chores

• deps: Update all non-major dependencies (#3000, d3da326)

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)

Bug Fixes

• api: Head requests for projectfilemanager (#2977, 96a18b0)

• 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

• Update pylint to 3.3.1 and resolve issues (#2997, a0729b8)

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

• Introduce related_issues to merge requests (#2996, 174d992)

• build: Build multi-arch images (#2987, 29f617d)

Bug Fixes

• client: Ensure type evaluations are postponed (b41b2de)

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)

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.

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)

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/PRs that have stale label to be closed (2ab88b2)

If a stale label is manually applied, allow the issue or PR 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)

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)

Bug Fixes

• Don't raise RedirectError for redirected HEAD requests (8fc13b9)

• Handle large number of approval rules (ef8f0e1)

Use iterator=True when going through the list of current approval rules. This allows it to handle more than the default of 20 approval rules.

Closes: #2825

• cli: Don't require --id when enabling a deploy key (98fc578)

No longer require --id when doing: gitlab project-key enable

Now only the --project-id and --key-id are required.

• deps: Update minimum dependency versions in pyproject.toml (37b5a70)

Update the minimum versions of the dependencies in the pyproject.toml file.

This is related to PR #2878

• projects: Fix 'import_project' file argument type for typings (33fbc14)

Signed-off-by: Adrian DC radian.dc@gmail.com

Chores

• Add an initial .git-blame-ignore-revs (74db84c)

This adds the .git-blame-ignore-revs file which allows ignoring certain commits when doing a git blame --ignore-revs

Ignore the commit that requires keyword arguments for register_custom_action()

https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view

• Add type info for ProjectFile.content (62fa271)

Closes: #2821

• Correct type-hint for job.trace() (840572e)

Closes: #2808

• Create a CustomAction dataclass (61d8679)

• Remove typing-extensions from requirements.txt (d569128)

We no longer support Python versions before 3.8. So it isn't needed anymore.

• Require keyword arguments for register_custom_action (7270523)

This makes it more obvious when reading the code what each argument is for.

• Update commit reference in git-blame-ignore-revs (d0fd5ad)

• cli: Add ability to not add _id_attr as an argument (2037352)

In some cases we don't want to have _id_attr as an argument.

Add ability to have it not be added as an argument.

• cli: Add some simple help for the standard operations (5a4a940)

Add help for the following standard operations: * 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

For 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

• cli: On the CLI help show the API endpoint of resources (f1ef565)

This makes it easier for people to map CLI command names to the API.

Looks like this: $ gitlab --help <snip> The GitLab resource to manipulate. application API endpoint: /applications application-appearance API endpoint: /application/appearance application-settings API endpoint: /application/settings application-statistics API endpoint: /application/statistics <snip>

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

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

• deps: Update dependency requests to v2.32.0 [security] (1bc788c)

• deps: Update gitlab/gitlab-ee docker tag to v17 (5070d07)

• deps: Update python-semantic-release/upload-to-gh-release digest to 673709c (1b550ac)

Features

• More usernames support for MR approvals (12d195a)

I don't think commit a2b8c8ccfb5d went far enough to enable usernames support. We create and edit a lot of approval rules based on an external service (similar to CODE_OWNERS), but only have the usernames available, and currently, have to look up each user to get their user ID to populate user_ids for .set_approvers() calls. Would very much like to skip the lookup and just send the usernames, which this change should allow.

See: https://docs.gitlab.com/ee/api/merge_request_approvals.html#create-project-level-rule

Signed-off-by: Jarod Wilson jarod@redhat.com

• api: Add additional parameter to project/group iteration search (#2796, 623dac9)

Co-authored-by: Cristiano Casella cristiano.casella@seacom.it

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

• api: Add support for gitlab service account (#2851, b187dea)

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

Bug Fixes

• Consider scope an ArrayAttribute in PipelineJobManager (c5d0404)

List query params like 'scope' were not being handled correctly for pipeline/jobs endpoint. This change ensures multiple values are appended with '[]', resulting in the correct URL structure.

Signed-off-by: Guilherme Gallo guilherme.gallo@collabora.com

---

Background: If one queries for pipeline jobs with scope=["failed", "success"]

One gets: GET /api/v4/projects/176/pipelines/1113028/jobs?scope=success&scope=failed

But it is supposed to get: GET /api/v4/projects/176/pipelines/1113028/jobs?scope[]=success&scope[]=failed

The current version only considers the last element of the list argument.

• User.warn() to show correct filename of issue (529f1fa)

Previously would only go to the 2nd level of the stack for determining the offending filename and line number. When it should be showing the first filename outside of the python-gitlab source code. As we want it to show the warning for the user of the libraries code.

Update test to show it works as expected.

• api: Fix saving merge request approval rules (b8b3849)

Closes #2548

• api: Update manual job status when playing it (9440a32)

• cli: Allow exclusive arguments as optional (#2770, 7ec3189)

• fix(cli): allow exclusive arguments as optional

The CLI takes its arguments from the RequiredOptional, which has three fields: required, optional, and exclusive. In practice, the exclusive options are not defined as either required or optional, and would not be allowed in the CLI. This changes that, so that exclusive options are also added to the argument parser.

• fix(cli): inform argument parser that options are mutually exclusive

• fix(cli): use correct exclusive options, add unit test

Closes #2769

• test: Use different ids for merge request, approval rule, project (c23e6bd)

The original bug was that the merge request identifier was used instead of the approval rule identifier. The test didn't notice that because it used 1 for all identifiers. Make these identifiers different so that a mixup will become apparent.

Build System

• Add "--no-cache-dir" to pip commands in Dockerfile (4ef94c8)

This would not leave cache files in the built docker image.

Additionally, also only build the wheel in the build phase.

On my machine, before this PR, size is 74845395; after this PR, size is 72617713.

Chores

• Adapt style for black v24 (4e68d32)

• Add py312 & py313 to tox environment list (679ddc7)

Even though there isn't a Python 3.13 at this time, this is done for the future. tox is already configured to just warn about missing Python versions, but not fail if they don't exist.

• Add tox labels to enable running groups of environments (d7235c7)

tox now has a feature of labels which allows running groups of environments using the command tox -m LABEL_NAME. For example tox -m lint which has been setup to run the linters.

Bumped the minimum required version of tox to be 4.0, which was released over a year ago.

• Update mypy to 1.9.0 and resolve one issue (dd00bfc)

mypy 1.9.0 flagged one issue in the code. Resolve the issue. Current unit tests already check that a None value returns text/plain. So function is still working as expected.

• Update version of black for pre-commit (3501716)

The version of black needs to be updated to be in sync with what is in requirements-lint.txt

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

• deps: Update all non-major dependencies (65d0e65)

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

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

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

• deps: Update all non-major dependencies (14a3ffe)

• deps: Update all non-major dependencies (3c4dcca)

• deps: Update all non-major dependencies (04c569a)

• deps: Update all non-major dependencies (3c4b27e)

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

• deps: Update all non-major dependencies (48726fd)

• deps: Update codecov/codecov-action action to v4 (d2be1f7)

• deps: Update dependency black to v24 (f59aee3)

• deps: Update dependency black to v24.3.0 [security] (f6e8692)

• deps: Update dependency furo to v2024 (f6fd02d)

• deps: Update dependency jinja2 to v3.1.4 [security] (8ea10c3)

• deps: Update dependency myst-parser to v3 (9289189)

• deps: Update dependency pytest to v8 (253babb)

• deps: Update dependency pytest-cov to v5 (db32000)

• deps: Update dependency pytest-docker to v3 (35d2aec)

• deps: Update gitlab/gitlab-ee docker tag to v16 (ea8c4c2)

• deps: Update gitlab/gitlab-ee docker tag to v16.11.1-ee.0 (1ed8d6c)

• deps: Update gitlab/gitlab-ee docker tag to v16.11.2-ee.0 (9be48f0)

• deps: Update python-semantic-release/python-semantic-release action to v9 (e11d889)

Documentation

• Add FAQ about conflicting parameters (683ce72)

We have received multiple issues lately about this. Add it to the FAQ.

• Correct rotate token example (c53e695)

Rotate token returns a dict. Change example to print the entire dict.

Closes: #2836

• How to run smoke tests (2d1f487)

Signed-off-by: Tim Knight tim.knight1@engineering.digital.dwp.gov.uk

• Note how to use the Docker image from within GitLab CI (6d4bffb)

Ref: #2823

• artifacts: Fix argument indentation (c631eeb)

• objects: Minor rst formatting typo (57dfd17)

To correctly format a code block have to use ::

• README: Tweak GitLab CI usage docs (d9aaa99)

Features

• api: Allow updating protected branches (#2771, a867c48)

• feat(api): allow updating protected branches

Closes #2390

• cli: Allow skipping initial auth calls (001e596)

• job_token_scope: Support Groups in job token allowlist API (#2816, 2d1b749)

• feat(job_token_scope): support job token access allowlist API

Signed-off-by: Tim Knight tim.knight1@engineering.digital.dwp.gov.uk

l.dwp.gov.uk> Co-authored-by: Nejc Habjan nejc.habjan@siemens.com

Testing

• Don't use weak passwords (c64d126)

Newer versions of GitLab will refuse to create a user with a weak password. In order for us to move to a newer GitLab version in testing use a stronger password for the tests that create a user.

• Remove approve step (48a6705)

Signed-off-by: Tim Knight tim.knight1@engineering.digital.dwp.gov.uk

• Tidy up functional tests (06266ea)

Signed-off-by: Tim Knight tim.knight1@engineering.digital.dwp.gov.uk

• Update api tests for GL 16.10 (4bef473)

• Make sure we're testing python-gitlab functionality, make sure we're not awaiting on Gitlab Async functions - Decouple and improve test stability

Signed-off-by: Tim Knight tim.knight1@engineering.digital.dwp.gov.uk

• Update tests for gitlab 16.8 functionality (f8283ae)

• use programmatic dates for expires_at in tokens tests - set PAT for 16.8 into tests

Signed-off-by: Tim Knight tim.knight1@engineering.digital.dwp.gov.uk

• functional: Enable bulk import feature flag before test (b81da2e)

• smoke: Normalize all dist titles for smoke tests (ee013fe)

Bug Fixes

• cli: Support binary files with @ notation (57749d4)

Support binary files being used in the CLI with arguments using the @ notation. For example --avatar @/path/to/avatar.png

Also explicitly catch the common OSError exception, which is the parent exception for things like: FileNotFoundError, PermissionError and more exceptions.

Remove the bare exception handling. We would rather have the full traceback of any exceptions that we don't know about and add them later if needed.

Closes: #2752

Chores

• ci: Add Python 3.13 development CI job (ff0c11b)

Add a job to test the development versions of Python 3.13.

• ci: Align upload and download action versions (dcca59d)

• deps: Update actions/upload-artifact action to v4 (7114af3)

• deps: Update all non-major dependencies (550f935)

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

• deps: Update all non-major dependencies (369a595)

• deps: Update dependency flake8 to v7 (20243c5)

• deps: Update dependency jinja2 to v3.1.3 [security] (880913b)

• deps: Update pre-commit hook pycqa/flake8 to v7 (9a199b6)

Features

• api: Add reviewer_details manager for mergrequest to get reviewers of merge request (adbd90c)

Those changes implements 'GET /projects/:id/merge_requests/:merge_request_iid/reviewers' gitlab API call. Naming for call is not reviewers because reviewers atribute already presen in merge request response

• api: Support access token rotate API (b13971d)

• api: Support single resource access token get API (dae9e52)

Bug Fixes

• cli: Add ability to disable SSL verification (3fe9fa6)

Add a --no-ssl-verify option to disable SSL verification

Closes: #2714

Chores

• deps: Update actions/setup-python action to v5 (fad1441)

• deps: Update actions/stale action to v9 (c01988b)

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

• deps: Update all non-major dependencies (9e067e5)

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

• deps: Update all non-major dependencies (5ef1b4a)

• deps: Update dependency types-setuptools to v69 (de11192)

Documentation

• Fix rst link typo in CONTRIBUTING.rst (2b6da6e)

Features

• api: Add support for the Draft notes API (#2728, ebf9d82)

• feat(api): add support for the Draft notes API

• fix(client): handle empty 204 reponses in PUT requests

Chores

• deps: Update all non-major dependencies (8aeb853)

• deps: Update all non-major dependencies (9fe2335)

• deps: Update all non-major dependencies (91e66e9)

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

• deps: Update dessant/lock-threads action to v5 (f4ce867)

Features

• Add pipeline status as Enum (4954bbc)

https://docs.gitlab.com/ee/api/pipelines.html

• api: Add support for wiki attachments (#2722, 7b864b8)

Added UploadMixin in mixin module Added UploadMixin dependency for Project, ProjectWiki, GroupWiki Added api tests for wiki upload Added unit test for mixin Added docs sections to wikis.rst

Bug Fixes

• build: Include py.typed in dists (b928639)

Chores

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

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

Documentation

• users: Add missing comma in v4 API create runner examples (b1b2edf)

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

Bug Fixes

• Remove depricated MergeStatus (c6c012b)

Chores

• Add source label to container image (7b19278)

• CHANGELOG: Re-add v4.0.0 changes using old format (258a751)

• CHANGELOG: Revert python-semantic-release format change (b5517e0)

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

• rtd: Revert to python 3.11 (#2694, 1113742)

Continuous Integration

• Remove unneeded GitLab auth (fd7bbfc)

Features

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

Bug Fixes

• cli: Add _from_parent_attrs to user-project manager (#2558, 016d90c)

• cli: Fix action display in --help when there are few actions (b22d662)

fixes #2656

• cli: Remove deprecated --all option in favor of --get-all (e9d48cf)

BREAKING CHANGE: The --all option is no longer available in the CLI. Use --get-all instead.

• client: Support empty 204 responses in http_patch (e15349c)

• snippets: Allow passing list of files (31c3c5e)

Chores

• Add package pipelines API link (2a2404f)

• Change _update_uses to _update_method and use an Enum (7073a2d)

Change the name of the _update_uses attribute to _update_method and store an Enum in the attribute to indicate which type of HTTP method to use. At the moment it supports POST and PUT. But can in the future support PATCH.

• Fix test names (f1654b8)

• Make linters happy (3b83d5d)

• Switch to docker-compose v2 (713b5ca)

Closes: #2625

• Update PyYAML to 6.0.1 (3b8939d)

Fixes issue with CI having error: AttributeError: cython_sources

Closes: #2624

• ci: Adapt release workflow and config for v8 (827fefe)

• ci: Fix pre-commit deps and python version (1e7f257)

• ci: Follow upstream config for release build_command (3e20a76)

• ci: Remove Python 3.13 dev job (e8c50f2)

• ci: Update release build for python-semantic-release v8 (#2692, bf050d1)

• deps: Bring furo up to date with sphinx (a15c927)

• deps: Bring myst-parser up to date with sphinx 7 (da03e9c)

• deps: Pin pytest-console-scripts for 3.7 (6d06630)

• deps: Update actions/checkout action to v3 (e2af1e8)

• deps: Update actions/checkout action to v4 (af13914)

• deps: Update actions/setup-python action to v4 (e0d6783)

• deps: Update actions/upload-artifact action to v3 (b78d6bf)

• deps: Update all non-major dependencies (1348a04)

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

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

• deps: Update all non-major dependencies (6093dbc)

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

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

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

• deps: Update all non-major dependencies (16f2d34)

• deps: Update all non-major dependencies (5b33ade)

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

• deps: Update all non-major dependencies (511f45c)

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

• deps: Update all non-major dependencies (12846cf)

• deps: Update all non-major dependencies (33d2aa2)

• deps: Update all non-major dependencies (5ff56d8)

• deps: Update all non-major dependencies (7586a5c)

• deps: Update all non-major dependencies to v23.9.1 (a16b732)

• deps: Update dependency build to v1 (2e856f2)

• deps: Update dependency commitizen to v3.10.0 (becd8e2)

• deps: Update dependency pylint to v3 (491350c)

• deps: Update dependency pytest-docker to v2 (b87bb0d)

• deps: Update dependency setuptools to v68 (0f06082)

• deps: Update dependency sphinx to v7 (2918dfd)

• deps: Update dependency types-setuptools to v68 (bdd4eb6)

• deps: Update dependency ubuntu to v22 (8865552)

• deps: Update pre-commit hook commitizen-tools/commitizen to v3.10.0 (626c2f8)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v36 (db58cca)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v37 (b4951cd)

• deps: Update pre-commit hook pycqa/pylint to v3 (0f4a346)

• deps: Update relekang/python-semantic-release action to v8 (c57c85d)

• helpers: Fix previously undetected flake8 issue (bf8bd73)

• rtd: Fix docs build on readthedocs.io (#2654, 3d7139b)

• rtd: Use readthedocs v2 syntax (6ce2149)

Documentation

• Correct error with back-ticks (#2653, 0b98dd3)

New linting package update detected the issue.

• access_token: Adopt token docs to 16.1 (fe7a971)

expires_at is now required Upstream MR: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124964

• advanced: Document new netrc behavior (45b8930)

BREAKING CHANGE: 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.

• files: Fix minor typo in variable declaration (118ce42)

Features

• Added iteration to issue and group filters (8d2d297)

• Officially support Python 3.12 (2a69c0e)

• Remove support for Python 3.7, require 3.8 or higher (058d5a5)

Python 3.8 is End-of-Life (EOL) as of 2023-06-27 as stated in https://devguide.python.org/versions/ and https://peps.python.org/pep-0537/

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

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

• Use requests AuthBase classes (5f46cfd)

• api: Add optional GET attrs for /projects/:id/ci/lint (40a102d)

• api: Add ProjectPackagePipeline (5b4addd)

Add ProjectPackagePipeline, which is scheduled to be included in GitLab 16.0

• api: Add support for job token scope settings (59d6a88)

• api: Add support for new runner creation API (#2635, 4abcd17)

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

• api: Support project remote mirror deletion (d900910)

• client: Mask tokens by default when logging (1611d78)

• packages: Allow uploading bytes and files (61e0fae)

This commit adds a keyword argument to GenericPackageManager.upload() to allow uploading bytes and file-like objects to the generic package registry. That necessitates changing file path to be a keyword argument as well, which then cascades into a whole slew of checks to not allow passing both and to not allow uploading file-like objects as JSON data.

Closes https://github.com/python-gitlab/python-gitlab/issues/1815

• releases: Add support for direct_asset_path (d054917)

This commit adds support for the “new” alias for filepath: direct_asset_path (added in 15.10) in release links API.

Refactoring

• artifacts: Remove deprecated artifact()in favor of artifacts.raw() (90134c9)

BREAKING CHANGE: The deprecated project.artifact() method is no longer available. Use project.artifacts.raw() instead.

• artifacts: Remove deprecated artifacts()in favor of artifacts.download() (42639f3)

BREAKING CHANGE: The deprecated project.artifacts() method is no longer available. Use project.artifacts.download() instead.

• build: Build project using PEP 621 (71fca8c)

BREAKING CHANGE: 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.

• const: Remove deprecated global constant import (e4a1f6e)

BREAKING CHANGE: Constants defined in gitlab.const can no longer be imported globally from gitlab. Import them from gitlab.const instead.

• groups: Remove deprecated LDAP group link add/delete methods (5c8b7c1)

BREAKING CHANGE: 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.

• lint: Remove deprecated lint()in favor of ci_lint.create() (0b17a2d)

BREAKING CHANGE: The deprecated lint() method is no longer available. Use ci_lint.create() instead.

• list: as_list support is removed. (9b6d89e)

In list() calls support for the as_list argument has been removed. as_list was previously deprecated and now the use of iterator will be required if wanting to have same functionality as using as_list

BREAKING CHANGE: Support for the deprecated as_list argument in list() calls has been removed. Use iterator instead.

• projects: Remove deprecated project.transfer_project() in favor of project.transfer() (27ed490)

BREAKING CHANGE: The deprecated project.transfer_project() method is no longer available. Use project.transfer() instead.

Testing

• Add tests for token masking (163bfcf)

• Correct calls to script_runner.run() (cd04315)

Warnings were being raised. Resolve those warnings.

• Fix failing tests that use 204 (No Content) plus content (3074f52)

urllib3>=2 now checks for expected content length. Also codes 204 and 304 are set to expect a content length of 0 [1]

So in the unit tests stop setting content to return in these situations.

[1] https://github.com/urllib3/urllib3/blob/88a707290b655394aade060a8b7eaee83152dc8b/src/urllib3/response.py#L691-L693

• cli: Add test for user-project list (a788cff)

BREAKING CHANGES

• advanced: 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.

• build: 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.

Chores

• Update copyright year to include 2023 (511c6e5)

• Update sphinx from 5.3.0 to 6.2.1 (c44a290)

• ci: Use OIDC trusted publishing for pypi.org (#2559, 7be09e5)

• chore(ci): use OIDC trusted publishing for pypi.org

• chore(ci): explicitly install setuptools in tests

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

• deps: Update dependency commitizen to v3 (784d59e)

• deps: Update dependency myst-parser to v1 (9c39848)

• deps: Update dependency requests-toolbelt to v1 (86eba06)

• deps: Update dependency types-setuptools to v67 (c562424)

• deps: Update pre-commit hook commitizen-tools/commitizen to v3 (1591e33)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v35 (8202e3f)

Documentation

• Remove exclusive EE about issue links (e0f6f18)

Features

• Add support for select="package_file" in package upload (3a49f09)

Add ability to use select="package_file" when uploading a generic package as described in: https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557

• Usernames support for MR approvals (a2b8c8c)

This can be used instead of 'user_ids'

See: https://docs.gitlab.com/ee/api/merge_request_approvals.html#create-project-level-rule

• api: Add support for events scope parameter (348f56e)

Bug Fixes

• Support int for parent_id in import_group (90f96ac)

This will also fix other use cases where an integer is passed in to MultipartEncoder.

Added unit tests to show it works.

Closes: #2506

• cli: Add ability to escape at-prefixed parameter (#2513, 4f7c784)

• fix(cli): Add ability to escape at-prefixed parameter (#2511)

---

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

• cli: Display items when iterator is returned (33a04e7)

• cli: Warn user when no fields are displayed (8bf53c8)

• client: Properly parse content-type when charset is present (76063c3)

Chores

• Add Contributor Covenant 2.1 as Code of Conduct (fe334c9)

See https://www.contributor-covenant.org/version/2/1/code_of_conduct/

• Add Python 3.12 testing (0867564)

Add a unit test for Python 3.12. This will use the latest version of Python 3.12 that is available from https://github.com/actions/python-versions/

At this time it is 3.12.0-alpha.4 but will move forward over time until the final 3.12 release and updates. So 3.12.0, 3.12.1, ... will be matched.

• Add SECURITY.md (572ca3b)

• Remove pre-commit as a default tox environment (#2470, fde2495)

For users who use tox having pre-commit as part of the default environment list is redundant as it will run the same tests again that are being run in other environments. For example: black, flake8, pylint, and more.

• Use a dataclass to return values from prepare_send_data (f2b5e4f)

I found the tuple of three values confusing. So instead use a dataclass to return the three values. It is still confusing but a little bit less so.

Also add some unit tests

• .github: Actually make PR template the default (7a8a862)

• ci: Wait for all coverage reports in CI status (511764d)

• contributing: Refresh development docs (d387d91)

• deps: Update actions/stale action to v8 (7ac4b86)

• deps: Update all non-major dependencies (8b692e8)

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

• deps: Update all non-major dependencies (#2493, 07d03dc)

• chore(deps): update all non-major dependencies * chore(fixtures): downgrade GitLab for now * chore(deps): ungroup typing deps, group gitlab instead * chore(deps): downgrade argcomplete for now

---

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

Co-authored-by: Nejc Habjan nejc.habjan@siemens.com

• deps: Update black (23.1.0) and commitizen (2.40.0) (#2479, 44786ef)

Update the dependency versions: black: 23.1.0

commitizen: 2.40.0

They needed to be updated together as just updating black caused a dependency conflict.

Updated files by running black and committing the changes.

• deps: Update dependency coverage to v7 (#2501, aee73d0)

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

• deps: Update dependency flake8 to v6 (#2502, 3d4596e)

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

• deps: Update dependency furo to v2023 (7a1545d)

• deps: Update dependency pre-commit to v3 (#2508, 7d779c8)

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

• deps: Update mypy (1.0.0) and responses (0.22.0) (9c24657)

Update the requirements-* files.

In order to update mypy==1.0.0 we need to also update responses==0.22.0

Fix one issue found by mypy

Leaving updates for precommit to be done in a separate commit by someone.

• deps: Update pre-commit hook psf/black to v23 (217a787)

• github: Add default pull request template (bf46c67)

• pre-commit: Bumping versions (e973729)

• renovate: Bring back custom requirements pattern (ae0b21c)

• renovate: Do not ignore tests dir (5b8744e)

• renovate: Swith to gitlab-ee (8da48ee)

• setup: Depend on typing-extensions for 3.7 until EOL (3abc557)

Documentation

• Fix update badge behaviour (3d7ca1c)

docs: fix update badge behaviour

Earlier: badge.image_link = new_link

Now: badge.image_url = new_image_url badge.link_url = new_link_url

• advanced: Clarify netrc, proxy behavior with requests (1da7c53)

• advanced: Fix typo in Gitlab examples (1992790)

• objects: Fix typo in pipeline schedules (3057f45)

Features

• Add resource_weight_event for ProjectIssue (6e5ef55)

• backends: Use PEP544 protocols for structural subtyping (#2442, 4afeaff)

The purpose of this change is to track API changes described in https://github.com/python-gitlab/python-gitlab/blob/main/docs/api-levels.rst, for example, for package versioning and breaking change announcements in case of protocol changes.

This is MVP implementation to be used by #2435.

• cli: Add setting of allow_force_push for protected branch (929e07d)

For the CLI: add allow_force_push as an optional argument for creating a protected branch.

API reference: https://docs.gitlab.com/ee/api/protected_branches.html#protect-repository-branches

Closes: #2466

• client: Add http_patch method (#2471, f711d9e)

In order to support some new API calls we need to support the HTTP PATCH method.

Closes: #2469

• objects: Support fetching PATs via id or self endpoint (19b38bd)

• projects: Allow importing additional items from GitHub (ce84f2e)

Refactoring

• client: Let mypy know http_password is set (2dd177b)

Testing

• functional: Clarify MR fixture factory name (d8fd1a8)

• meta: Move meta suite into unit tests (847004b)

They're always run with it anyway, so it makes no difference.

• unit: Consistently use inline fixtures (1bc56d1)

• unit: Increase V4 CLI coverage (5748d37)

• unit: Remove redundant package (4a9e3ee)

• unit: Split the last remaining unittest-based classes into modules" (14e0f65)

Bug Fixes

• Change return value to "None" in case getattr returns None to prevent error (3f86d36)

• Typo fixed in docs (ee5f444)

• Use the ProjectIterationManager within the Project object (44f05dc)

The Project object was previously using the GroupIterationManager resulting in the incorrect API endpoint being used. Utilize the correct ProjectIterationManager instead.

Resolves #2403

• api: Make description optional for releases (5579750)

• client: Regression - do not automatically get_next if page=# and (585e3a8)

• deps: Bump requests-toolbelt to fix deprecation warning (faf842e)

Chores

• Add a UserWarning if both iterator=True and page=X are used (#2462, 8e85791)

If a caller calls a list() method with both iterator=True (or as_list=False) and page=X then emit a UserWarning as the options are mutually exclusive.

• Add docs for schedule pipelines (9a9a6a9)

• Add test, docs, and helper for 409 retries (3e1c625)

• Make backends private (1e629af)

• Remove tox envdir values (3c7c7fc)

tox > 4 no longer will re-use the tox directory :( What this means is that with the previous config if you ran: $ tox -e mypy; tox -e isort; tox -e mypy It would recreate the tox environment each time :(

By removing the envdir values it will have the tox environments in separate directories and not recreate them.

The have an FAQ entry about this: https://tox.wiki/en/latest/upgrading.html#re-use-of-environments

• Update attributes for create and update projects (aa44f2a)

• Use SPDX license expression in project metadata (acb3a4a)

• ci: Complete all unit tests even if one has failed (#2438, 069c6c3)

• deps: Update actions/download-artifact action to v3 (64ca597)

• deps: Update actions/stale action to v7 (76eb024)

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

• deps: Update all non-major dependencies (122988c)

• deps: Update all non-major dependencies (49c0233)

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

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

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

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

• deps: Update all non-major dependencies (21e767d)

• deps: Update dessant/lock-threads action to v4 (337b25c)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v34.48.4 (985b971)

• deps: Update pre-commit hook pycqa/flake8 to v6 (82c61e1)

• tox: Ensure test envs have all dependencies (63cf4e4)

Documentation

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

Features

• Add keep_base_url when getting configuration from file (50a0301)

• Add resource iteration events (see https://docs.gitlab.com/ee/api/resource_iteration_events.html) (ef5feb4)

• Allow filtering pipelines by source (b6c0872)

See: https://docs.gitlab.com/ee/api/pipelines.html#list-project-pipelines Added in GitLab 14.3

• Allow passing kwargs to Gitlab class when instantiating with from_config (#2392, e88d34e)

• api: Add support for bulk imports API (043de2d)

• api: Add support for resource groups (5f8b8f5)

• api: Support listing pipelines triggered by pipeline schedules (865fa41)

• client: Automatically retry on HTTP 409 Resource lock (dced76a)

Fixes: #2325

• client: Bootstrap the http backends concept (#2391, 91a665f)

• group: Add support for group restore API (9322db6)

Refactoring

• Add reason property to RequestsResponse (#2439, b59b7bd)

• Migrate MultipartEncoder to RequestsBackend (#2421, 43b369f)

• Move Response object to backends (#2420, 7d9ce0d)

• Move the request call to the backend (#2413, 283e7cc)

• Moving RETRYABLE_TRANSIENT_ERROR_CODES to const (887852d)

• Remove unneeded requests.utils import (#2426, 6fca651)

Testing

• functional: Do not require config file (43c2dda)

• unit: Expand tests for pipeline schedules (c7cf0d1)

Bug Fixes

• Use POST method and return dict in cancel_merge_when_pipeline_succeeds() (#2350, bd82d74)

• Call was incorrectly using a PUT method when should have used a POST method. * Changed return type to a dict as GitLab only returns {'status': 'success'} on success. Since the function didn't work previously, this should not impact anyone. * Updated the test fixture merge_request to add ability to create a pipeline. * Added functional test for mr.cancel_merge_when_pipeline_succeeds()

Fixes: #2349

• cli: Enable debug before doing auth (65abb85)

Authentication issues are currently hard to debug since --debug only has effect after gl.auth() has been called.

For example, a 401 error is printed without any details about the actual HTTP request being sent:

$ gitlab --debug --server-url https://gitlab.com current-user get 401: 401 Unauthorized

By moving the call to gl.enable_debug() the usual debug logs get printed before the final error message.

Signed-off-by: Emanuele Aina emanuele.aina@collabora.com

• cli: Expose missing mr_default_target_self project attribute (12aea32)

Example::

gitlab project update --id 616 --mr-default-target-self 1

References:

• https://gitlab.com/gitlab-org/gitlab/-/merge_requests/58093 * https://gitlab.com/gitlab-org/gitlab/-/blob/v13.11.0-ee/doc/user/project/merge_requests/creating_merge_requests.md#new-merge-request-from-a-fork
  • https://gitlab.com/gitlab-org/gitlab/-/blob/v14.7.0-ee/doc/api/projects.md#get-single-project

Chores

• Correct website for pylint (fcd72fe)

Use https://github.com/PyCQA/pylint as the website for pylint.

• Validate httpx package is not installed by default (0ecf3bb)

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

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

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v34 (623e768)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v34.20.0 (e6f1bd6)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v34.24.0 (a0553c2)

Documentation

• Use the term "log file" for getting a job log file (9d2b1ad)

The GitLab docs refer to it as a log file: https://docs.gitlab.com/ee/api/jobs.html#get-a-log-file

"trace" is the endpoint name but not a common term people will think of for a "log file"

• api: Pushrules remove saying None is returned when not found (c3600b4)

In groups.pushrules.get(), GitLab does not return None when no rules are found. GitLab returns a 404.

Update docs to not say it will return None

Also update docs in project.pushrules.get() to be consistent. Not 100% sure if it returns None or returns a 404, but we don't need to document that.

Closes: #2368

• groups: Describe GitLab.com group creation limitation (9bd433a)

Features

• Add support for SAML group links (#2367, 1020ce9)

• Implement secure files API (d0a0348)

• api: Add application statistics (6fcf3b6)

• api: Add support for getting a project's pull mirror details (060cfe1)

Add the ability to get a project's pull mirror details. This was added in GitLab 15.5 and is a PREMIUM feature.

https://docs.gitlab.com/ee/api/projects.html#get-a-projects-pull-mirror-details

• api: Add support for remote project import (#2348, e5dc72d)

• api: Add support for remote project import from AWS S3 (#2357, 892281e)

• ci: Re-run Tests on PR Comment workflow (034cde3)

• groups: Add LDAP link manager and deprecate old API endpoints (3a61f60)

• groups: Add support for listing ldap_group_links (#2371, ad7c8fa)

Refactoring

• Explicitly use ProjectSecureFile (0c98b2d)

Testing

• api: Fix flaky test test_cancel_merge_when_pipeline_succeeds (6525c17)

This is an attempt to fix the flaky test test_cancel_merge_when_pipeline_succeeds. Were seeing a: 405 Method Not Allowed error when setting the MR to merge_when_pipeline_succeeds.

Closes: #2383

Bug Fixes

• Intermittent failure in test_merge_request_reset_approvals (3dde36e)

Have been seeing intermittent failures in the test: tests/functional/api/test_merge_requests.py::test_merge_request_reset_approvals

Also saw a failure in: tests/functional/cli/test_cli_v4.py::test_accept_request_merge[subprocess]

Add a call to wait_for_sidekiq() to hopefully resolve the issues.

• Remove project.approvals.set_approvals() method (91f08f0)

The project.approvals.set_approvals() method used the /projects/:id/approvers end point. That end point was removed from GitLab in the 13.11 release, on 2-Apr-2021 in commit 27dc2f2fe81249bbdc25f7bd8fe799752aac05e6 via merge commit e482597a8cf1bae8e27abd6774b684fb90491835. It was deprecated on 19-Aug-2019.

See merge request: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57473

• Use epic id instead of iid for epic notes (97cae38)

• cli: Handle list response for json/yaml output (9b88132)

Handle the case with the CLI where a list response is returned from GitLab and json/yaml output is requested.

Add a functional CLI test to validate it works.

Closes: #2287

Chores

• Add not-callable to pylint ignore list (f0c02a5)

The not-callable error started showing up. Ignore this error as it is invalid. Also mypy tests for these issues.

Closes: #2334

• Add basic type checks to functional/api tests (5b642a5)

• Add basic type checks to meta tests (545d6d6)

• Add basic typing to functional tests (ee143c9)

• Add basic typing to smoke tests (64e8c31)

• Add basic typing to test root (0b2f6bc)

• Add responses to pre-commit deps (4b8ddc7)

• Fix flaky test (fdd4114)

• Narrow type hints for license API (50731c1)

• Renovate and precommit cleanup (153d373)

• Revert compose upgrade (dd04e8e)

This reverts commit f825d70e25feae8cd9da84e768ec6075edbc2200.

• Simplify wait_for_sidekiq usage (196538b)

Simplify usage of wait_for_sidekiq by putting the assert if it timed out inside the function rather than after calling it.

• Topic functional tests (d542eba)

• Update the issue templates (c15bd33)

• Have an option to go to the discussions * Have an option to go to the Gitter chat * Move the bug/issue template into the .github/ISSUE_TEMPLATE/ directory

• Use kwargs for http_request docs (124abab)

• deps: Group non-major upgrades to reduce noise (37d14bd)

• deps: Pin and clean up test dependencies (60b9197)

• deps: Pin dependencies (953f38d)

• deps: Pin GitHub Actions (8dbaa5c)

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

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

• deps: Update black to v22.10.0 (531ee05)

• deps: Update dependency commitizen to v2.35.0 (4ce9559)

• deps: Update dependency mypy to v0.981 (da48849)

• deps: Update dependency pylint to v2.15.3 (6627a60)

• deps: Update dependency types-requests to v2.28.11.2 (d47c0f0)

• deps: Update pre-commit hook maxbrunet/pre-commit-renovate to v33 (932bbde)

• deps: Update typing dependencies (81285fa)

Documentation

• Add minimal docs about the enable_debug() method (b4e9ab7)

Add some minimal documentation about the enable_debug() method.

• advanced: Add hint on type narrowing (a404152)

• api: Describe the list() and all() runners' functions (b6cc3f2)

• api: Describe use of lower-level methods (b7a6874)

• api: Update merge_requests.rst: mr_id to mr_iid (b32234d)

Typo: Author probably meant mr_iid (i.e. project-specific MR ID)

and not mr_id (i.e. server-wide MR ID)

Closes: https://github.com/python-gitlab/python-gitlab/issues/2295

Signed-off-by: Stavros Ntentos 133706+stdedos@users.noreply.github.com

• commits: Fix commit create example for binary content (bcc1eb4)

• readme: Add a basic feature list (b4d53f1)

Features

• api: Add support for topics merge API (9a6d197)

• build: Officially support Python 3.11 (74f66c7)

Refactoring

• Migrate legacy EE tests to pytest (88c2505)

• Pre-commit trigger from tox (6e59c12)

• Pytest-docker fixtures (3e4781a)

• deps: Drop compose v1 dependency in favor of v2 (f825d70)

Testing

• Enable skipping tests per GitLab plan (01d5f68)

• Fix test_project_push_rules test (8779cf6)

Make the test_project_push_rules test work.

• Use false instead of /usr/bin/false (51964b3)

On Debian systems false is located at /bin/false (coreutils package). This fixes unit test failure on Debian system:

FileNotFoundError: [Errno 2] No such file or directory: '/usr/bin/false'

/usr/lib/python3.10/subprocess.py:1845: FileNotFoundError

Bug Fixes

• cli: Add missing attribute for MR changes (20c46a0)

• cli: Add missing attributes for creating MRs (1714d0a)

Chores

• Bump GitLab docker image to 15.4.0-ee.0 (b87a2bc)

• Use settings.delayed_group_deletion=False as that is the recommended method to turn off the delayed group deletion now. * Change test to look for default as pages is not mentioned in the docs[1]

[1] https://docs.gitlab.com/ee/api/sidekiq_metrics.html#get-the-current-queue-metrics

• deps: Update black to v22.8.0 (86b0e40)

• deps: Update dependency commitizen to v2.32.2 (31aea28)

• deps: Update dependency commitizen to v2.32.5 (e180f14)

• deps: Update dependency pytest to v7.1.3 (ec7f26c)

• deps: Update dependency types-requests to v2.28.10 (5dde7d4)

• deps: Update pre-commit hook commitizen-tools/commitizen to v2.32.2 (31ba64f)

Features

• Add reset_approvals api (88693ff)

Added the newly added reset_approvals merge request api.

Signed-off-by: Lucas Zampieri lzampier@redhat.com

• Add support for deployment approval endpoint (9c9eeb9)

Add support for the deployment approval endpoint[1]

[1] https://docs.gitlab.com/ee/api/deployments.html#approve-or-reject-a-blocked-deployment Closes: #2253

Chores

• Fix issue if only run test_gitlab.py func test (98f1956)

Make it so can run just the test_gitlab.py functional test.

For example: $ tox -e api_func_v4 -- -k test_gitlab.py

• Only check for our UserWarning (bd4dfb4)

The GitHub CI is showing a ResourceWarning, causing our test to fail.

Update test to only look for our UserWarning which should not appear.

What was seen when debugging the GitHub CI: {message: ResourceWarning( "unclosed <socket.socket fd=12, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=6, laddr=('127.0.0.1', 50862), raddr=('127.0.0.1', 8080)>" ), category: 'ResourceWarning', filename: '/home/runner/work/python-gitlab/python-gitlab/.tox/api_func_v4/lib/python3.10/site-packages/urllib3/poolmanager.py', lineno: 271, line: None }

• ci: Make pytest annotations work (f67514e)

• deps: Update dependency commitizen to v2.31.0 (4ff0894)

• deps: Update dependency commitizen to v2.32.1 (9787c5c)

• deps: Update dependency types-requests to v2.28.8 (8e5b86f)

• deps: Update dependency types-requests to v2.28.9 (be932f6)

• deps: Update dependency types-setuptools to v64 (4c97f26)

• deps: Update pre-commit hook commitizen-tools/commitizen to v2.31.0 (71d37d9)

• deps: Update pre-commit hook commitizen-tools/commitizen to v2.32.1 (cdd6efe)

• deps: Update pre-commit hook pycqa/flake8 to v5 (835d884)

Features

• Add support for merge_base API (dd4fbd5)

Bug Fixes

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

This is mostly relevant for people mocking the API in tests.

Chores

• Add license badge to readme (9aecc9e)

• Consolidate license and authors (366665e)

• Remove broad Exception catching from config.py (0abc90b)

Change "except Exception:" catching to more granular exceptions.

A step in enabling the "broad-except" check in pylint.

• deps: Update dependency commitizen to v2.29.5 (181390a)

• deps: Update dependency flake8 to v5.0.4 (50a4fec)

• deps: Update dependency sphinx to v5 (3f3396e)

Bug Fixes

• Optionally keep user-provided base URL for pagination (#2149, e2ea8b8)

• client: Ensure encoded query params are never duplicated (1398426)

Chores

• Change _repr_attr for Project to be path_with_namespace (7cccefe)

Previously _repr_attr was path but that only gives the basename of the path. So https://gitlab.com/gitlab-org/gitlab would only show "gitlab". Using path_with_namespace it will now show "gitlab-org/gitlab"

• Enable mypy check disallow_any_generics (24d17b4)

• Enable mypy check no_implicit_optional (64b208e)

• Enable mypy check warn_return_any (76ec4b4)

Update code so that the warn_return_any check passes.

• Make code PEP597 compliant (433dba0)

Use encoding="utf-8" in open() and open-like functions.

https://peps.python.org/pep-0597/

• Use urlunparse instead of string replace (6d1b62d)

Use the urlunparse() function to reconstruct the URL without the query parameters.

• ci: Bump semantic-release for fixed commit parser (1e063ae)

• clusters: Deprecate clusters support (b46b379)

Cluster support was deprecated in GitLab 14.5 [1]. And disabled by default in GitLab 15.0 [2]

• Update docs to mark clusters as deprecated * Remove testing of clusters

[1] https://docs.gitlab.com/ee/api/project_clusters.html [2] https://gitlab.com/groups/gitlab-org/configure/-/epics/8

• deps: Update dependency commitizen to v2.29.2 (30274ea)

• deps: Update dependency flake8 to v5 (cdc384b)

• deps: Update dependency types-requests to v2.28.6 (54dd4c3)

• deps: Update pre-commit hook commitizen-tools/commitizen to v2.29.2 (4988c02)

• topics: 'title' is required when creating a topic (271f688)

In GitLab >= 15.0 title is required when creating a topic.

Documentation

• Describe self-revoking personal access tokens (5ea48fc)

Features

• Support downloading archive subpaths (cadb0e5)

• client: Warn user on misconfigured URL in auth() (0040b43)

Refactoring

• client: Factor out URL check into a helper (af21a18)

• client: Remove handling for incorrect link header (77c04b1)

This was a quirk only present in GitLab 13.0 and fixed with 13.1. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33714 and https://gitlab.com/gitlab-org/gitlab/-/issues/218504 for more context.

Testing

• Attempt to make functional test startup more reliable (67508e8)

The functional tests have been erratic. Current theory is that we are starting the tests before the GitLab container is fully up and running.

• Add checking of the Health Check[1] endpoints. * Add a 20 second delay after we believe it is up and running. * Increase timeout from 300 to 400 seconds

[1] https://docs.gitlab.com/ee/user/admin_area/monitoring/health_check.html

• functional: Bump GitLab docker image to 15.2.0-ee.0 (69014e9)

Use the GitLab docker image 15.2.0-ee.0 in the functional testing.

• unit: Reproduce duplicate encoded query params (6f71c66)

Bug Fixes

• Add get_all param (and --get-all) to allow passing all to API (7c71d5d)

• Enable epic notes (5fc3216)

Add the notes attribute to GroupEpic

• Ensure path elements are escaped (5d9c198)

Ensure the path elements that are passed to the server are escaped. For example a "/" will be changed to "%2F"

Closes: #2116

• Results returned by attributes property to show updates (e5affc8)

Previously the attributes method would show the original values in a Gitlab Object even if they had been updated. Correct this so that the updated value will be returned.

Also use copy.deepcopy() to ensure that modifying the dictionary returned can not also modify the object.

• Support array types for most resources (d9126cd)

• Use the [] after key names for array variables in params (1af44ce)

1. If a value is of type ArrayAttribute then append '[]' to the name of the value for query parameters (params).

This is step 3 in a series of steps of our goal to add full support for the GitLab API data types[1]: * array * hash * array of hashes

Step one was: commit 5127b1594c00c7364e9af15e42d2e2f2d909449b Step two was: commit a57334f1930752c70ea15847a39324fa94042460

Fixes: #1698

[1] https://docs.gitlab.com/ee/api/#encoding-api-parameters-of-array-and-hash-types

• cli: Remove irrelevant MR approval rule list filters (0daec5f)

• config: Raise error when gitlab id provided but no config file found (ac46c1c)

• config: Raise error when gitlab id provided but no config section found (1ef7018)

• runners: Fix listing for /runners/all (c6dd57c)

Chores

• Add a lazy boolean attribute to RESTObject (a7e8cfb)

This can be used to tell if a RESTObject was created using lazy=True.

Add a message to the AttributeError if attribute access fails for an instance created with lazy=True.

• Change name of API functional test to api_func_v4 (8cf5cd9)

The CLI test is cli_func_v4 and using api_func_v4 matches with that naming convention.

• Enable mypy check strict_equality (a29cd6c)

Enable the mypy strict_equality check.

• Enable using GitLab EE in functional tests (17c01ea)

Enable using GitLab Enterprise Edition (EE) in the functional tests. This will allow us to add functional tests for EE only features in the functional tests.

• Fix misspelling (2d08fc8)

• Fixtures: after delete() wait to verify deleted (1f73b6b)

In our fixtures that create: - groups - project merge requests - projects - users

They delete the created objects after use. Now wait to ensure the objects are deleted before continuing as having unexpected objects existing can impact some of our tests.

• Make reset_gitlab() better (d87d6b1)

Saw issues in the CI where reset_gitlab() would fail. It would fail to delete the group that is created when GitLab starts up. Extending the timeout didn't fix the issue.

Changed the code to use the new helpers.safe_delete() function. Which will delete the resource and then make sure it is deleted before returning.

Also added some logging functionality that can be seen if logging is turned on in pytest.

• Revert "test(functional): simplify token creation" (4b798fc)

This reverts commit 67ab24fe5ae10a9f8cc9122b1a08848e8927635d.

• Simplify multi-nested try blocks (e734470)

Instead of have a multi-nested series of try blocks. Convert it to a more readable series of if statements.

• authors: Fix email and do the ABC (9833632)

• ci_lint: Add create attributes (6e1342f)

• deps: Update black to v22.6.0 (82bd596)

• deps: Update dependency commitizen to v2.28.0 (8703dd3)

• deps: Update dependency commitizen to v2.29.0 (c365be1)

• deps: Update dependency mypy to v0.971 (7481d27)

• deps: Update dependency pylint to v2.14.4 (2cee2d4)

• deps: Update dependency pylint to v2.14.5 (e153636)

• deps: Update dependency requests to v2.28.1 (be33245)

• deps: Update pre-commit hook commitizen-tools/commitizen to v2.28.0 (d238e1b)

• deps: Update pre-commit hook commitizen-tools/commitizen to v2.29.0 (ad8d62a)

• deps: Update pre-commit hook pycqa/pylint to v2.14.4 (5cd39be)

• deps: Update pre-commit hook pycqa/pylint to v2.14.5 (c75a1d8)

• deps: Update typing dependencies (f2209a0)

• deps: Update typing dependencies (e772248)

• docs: Convert tabs to spaces (9ea5520)

Some tabs snuck into the documentation. Convert them to 4-spaces.

Documentation

• Describe fetching existing export status (9c5b8d5)

• Describe ROPC flow in place of password authentication (91c17b7)

• Document CI Lint usage (d5de4b1)

• Update return type of pushrules (53cbecc)

Update the return type of pushrules to surround None with back-ticks to make it code-formatted.

• authors: Add John (e2afb84)

• cli: Showcase use of token scopes (4a6f8d6)

• projects: Document export with upload to URL (03f5484)

• readme: Remove redundant -v that breaks the command (c523e18)

• users: Add docs about listing a user's projects (065a1a5)

Add docs about listing a user's projects.

Update docs on the membership API to update the URL to the upstream docs and also add a note that it requires Administrator access to use.

Features

• Add 'merge_pipelines_enabled' project attribute (fc33c93)

Boolean. Enable or disable merge pipelines.

See: https://docs.gitlab.com/ee/api/projects.html#edit-project https://docs.gitlab.com/ee/ci/pipelines/merged_results_pipelines.html

• Add asdict() and to_json() methods to Gitlab Objects (08ac071)

Add an asdict() method that returns a dictionary representation copy of the Gitlab Object. This is a copy and changes made to it will have no impact on the Gitlab Object.

The asdict() method name was chosen as both the dataclasses and attrs libraries have an asdict() function which has the similar purpose of creating a dictionary represenation of an object.

Also add a to_json() method that returns a JSON string representation of the object.

Closes: #1116

• Add support for filtering jobs by scope (0e1c0dd)

See: 'scope' here:

https://docs.gitlab.com/ee/api/jobs.html#list-project-jobs

• Add support for group and project invitations API (7afd340)

• Add support for group push rules (b5cdc09)

Add the GroupPushRules and GroupPushRulesManager classes.

Closes: #1259

• Add support for iterations API (194ee01)

• Allow sort/ordering for project releases (b1dd284)

See: https://docs.gitlab.com/ee/api/releases/#list-releases

• Support validating CI lint results (3b1ede4)

• api: Add support for get for a MR approval rule (89c18c6)

In GitLab 14.10 they added support to get a single merge request approval rule [1]

Add support for it to ProjectMergeRequestApprovalRuleManager

[1] https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-a-single-merge-request-level-rule

• api: Add support for instance-level registry repositories (284d739)

• cli: Add a custom help formatter (005ba93)

Add a custom argparse help formatter that overrides the output format to list items vertically.

The formatter is derived from argparse.HelpFormatter with minimal changes.

Co-authored-by: John Villalovos john@sodarock.com

Co-authored-by: Nejc Habjan nejc.habjan@siemens.com

• cli: Add support for global CI lint (3f67c4b)

• groups: Add support for group-level registry repositories (70148c6)

• groups: Add support for shared projects API (66461ba)

• issues: Add support for issue reorder API (8703324)

• namespaces: Add support for namespace existence API (4882cb2)

• objects: Add Project CI Lint support (b213dd3)

Add support for validating a project's CI configuration [1]

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

• projects: Add support for project restore API (4794ecc)

Refactoring

• Migrate services to integrations (a428051)

• objects: Move ci lint to separate file (6491f1b)

• test-projects: Apply suggestions and use fixtures (a51f848)

• test-projects: Remove test_restore_project (9be0875)

Testing

• Add more tests for container registries (f6b6e18)

• Add test to show issue fixed (75bec7d)

https://github.com/python-gitlab/python-gitlab/issues/1698 has been fixed. Add test to show that.

• Allow podman users to run functional tests (ff215b7)

Users of podman will likely have DOCKER_HOST set to something like unix:///run/user/1000/podman/podman.sock

Pass this environment variable so that it will be used during the functional tests.

• Always ensure clean config environment (8d4f13b)

• Fix broken test if user had config files (864fc12)

Use monkeypatch to ensure that no config files are reported for the test.

Closes: #2172

• api_func_v4: Catch deprecation warning for gl.lint() (95fe924)

Catch the deprecation warning for the call to gl.lint(), so it won't show up in the log.

• cli: Add tests for token scopes (263fe3d)

• ee: Add an EE specific test (10987b3)

• functional: Replace len() calls with list membership checks (97e0eb9)

• functional: Simplify token creation (67ab24f)

• functional: Use both get_all and all in list() tests (201298d)

• projects: Add unit tests for projects (67942f0)