Hnasar · Hnasar · Jan 25, 2022 · Jan 25, 2022 · Jan 27, 2022 · Jan 28, 2022
diff --git a/.commitlintrc.json b/.commitlintrc.json
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -22,9 +22,9 @@ jobs:
  sphinx:
    runs-on: ubuntu-20.04
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
      - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
        with:
          python-version: "3.10"
      - name: Install dependencies
@@ -34,17 +34,17 @@ jobs:
          TOXENV: docs
        run: tox
      - name: Archive generated docs
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
        with:
          name: html-docs
          path: build/sphinx/html/

  twine-check:
    runs-on: ubuntu-20.04
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
      - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
        with:
          python-version: "3.10"
      - name: Install dependencies

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -19,20 +19,16 @@ env:
  PY_COLORS: 1

 jobs:
-  commitlint:
+  lint:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v4
-
-  linters:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v3
      - run: pip install --upgrade tox
+      - name: Run commitizen
+        run: tox -e cz
      - name: Run black code formatter (https://black.readthedocs.io/en/stable/)
        run: tox -e black -- --check
      - name: Run flake8 (https://flake8.pycqa.org/en/latest/)

diff --git a/.github/workflows/pre_commit.yml b/.github/workflows/pre_commit.yml
@@ -29,8 +29,8 @@ jobs:
  pre_commit:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
      - run: pip install --upgrade -r requirements.txt -r requirements-lint.txt pre-commit
      - name: Run pre-commit install
        run: pre-commit install

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,9 +7,10 @@ on:

 jobs:
  release:
+    if: github.repository == 'python-gitlab/python-gitlab'
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
      with:
        fetch-depth: 0
        token: ${{ secrets.RELEASE_GITHUB_TOKEN }}

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -15,7 +15,7 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
        with:
          any-of-labels: 'need info,Waiting for response'
          stale-issue-message: >

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -45,27 +45,27 @@ jobs:
              version: "3.10"
              toxenv: py310,smoke
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python.version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
        with:
          python-version: ${{ matrix.python.version }}
      - name: Install dependencies
        run: pip3 install tox pytest-github-actions-annotate-failures
      - name: Run tests
        env:
          TOXENV: ${{ matrix.python.toxenv }}
-        run: tox
+        run: tox --skip-missing-interpreters false

  functional:
    runs-on: ubuntu-20.04
    strategy:
      matrix:
        toxenv: [py_func_v4, cli_func_v4]
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
      - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
        with:
          python-version: "3.10"
      - name: Install dependencies
@@ -75,7 +75,7 @@ jobs:
          TOXENV: ${{ matrix.toxenv }}
        run: tox -- --override-ini='log_cli=True'
      - name: Upload codecov coverage
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
        with:
          files: ./coverage.xml
          flags: ${{ matrix.toxenv }}
@@ -84,9 +84,9 @@ jobs:
  coverage:
    runs-on: ubuntu-20.04
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
        with:
          python-version: "3.10"
      - name: Install dependencies
@@ -97,7 +97,7 @@ jobs:
          TOXENV: cover
        run: tox
      - name: Upload codecov coverage
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
        with:
          files: ./coverage.xml
          flags: unit

diff --git a/.gitignore b/.gitignore
@@ -15,7 +15,6 @@ docs/_build
 venv/

 # Include tracked hidden files and directories in search and diff tools
-!.commitlintrc.json
 !.dockerignore
 !.env
 !.github/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,14 +3,13 @@ default_language_version:

 repos:
  - repo: https://github.com/psf/black
-    rev: 21.12b0
+    rev: 22.3.0
    hooks:
      - id: black
-  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v6.0.0
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.24.0
    hooks:
-      - id: commitlint
-        additional_dependencies: ['@commitlint/config-conventional']
+      - id: commitizen
        stages: [commit-msg]
  - repo: https://github.com/pycqa/flake8
    rev: 4.0.1
@@ -21,13 +20,13 @@ repos:
    hooks:
      - id: isort
  - repo: https://github.com/pycqa/pylint
-    rev: v2.12.2
+    rev: v2.13.7
    hooks:
      - id: pylint
        additional_dependencies:
          - argcomplete==2.0.0
-          - pytest==6.2.5
-          - requests==2.27.0
+          - pytest==7.1.2
+          - requests==2.27.1
          - requests-toolbelt==0.9.1
        files: 'gitlab/'
  - repo: https://github.com/pre-commit/mirrors-mypy
@@ -36,6 +35,6 @@ repos:
      - id: mypy
        args: []
        additional_dependencies:
-          - types-PyYAML==6.0.1
-          - types-requests==2.26.3
-          - types-setuptools==57.4.5
+          - types-PyYAML==6.0.7
+          - types-requests==2.27.25
+          - types-setuptools==57.4.14
diff --git a/.renovaterc.json b/.renovaterc.json
@@ -1,7 +1,8 @@
 {
  "extends": [
    "config:base",
-    ":enablePreCommit"
+    ":enablePreCommit",
+    "schedule:weekly"
  ],
  "pip_requirements": {
    "fileMatch": ["^requirements(-[\\w]*)?\\.txt$"]

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,65 @@

 <!--next-version-placeholder-->

+## v3.4.0 (2022-04-28)
+### Feature
+* Emit a warning when using a `list()` method returns max ([`1339d64`](https://github.com/python-gitlab/python-gitlab/commit/1339d645ce58a2e1198b898b9549ba5917b1ff12))
+* **objects:** Support getting project/group deploy tokens by id ([`fcd37fe`](https://github.com/python-gitlab/python-gitlab/commit/fcd37feff132bd5b225cde9d5f9c88e62b3f1fd6))
+* **user:** Support getting user SSH key by id ([`6f93c05`](https://github.com/python-gitlab/python-gitlab/commit/6f93c0520f738950a7c67dbeca8d1ac8257e2661))
+* **api:** Re-add topic delete endpoint ([`d1d96bd`](https://github.com/python-gitlab/python-gitlab/commit/d1d96bda5f1c6991c8ea61dca8f261e5b74b5ab6))
+
+### Fix
+* Add ChunkedEncodingError to list of retryable exceptions ([`7beb20f`](https://github.com/python-gitlab/python-gitlab/commit/7beb20ff7b7b85fb92fc6b647d9c1bdb7568f27c))
+* Avoid passing redundant arguments to API ([`3431887`](https://github.com/python-gitlab/python-gitlab/commit/34318871347b9c563d01a13796431c83b3b1d58c))
+* **cli:** Add missing filters for project commit list ([`149d244`](https://github.com/python-gitlab/python-gitlab/commit/149d2446fcc79b31d3acde6e6d51adaf37cbb5d3))
+* Add 52x range to retry transient failures and tests ([`c3ef1b5`](https://github.com/python-gitlab/python-gitlab/commit/c3ef1b5c1eaf1348a18d753dbf7bda3c129e3262))
+* Also retry HTTP-based transient errors ([`3b49e4d`](https://github.com/python-gitlab/python-gitlab/commit/3b49e4d61e6f360f1c787aa048edf584aec55278))
+
+### Documentation
+* **api-docs:** Docs fix for application scopes ([`e1ad93d`](https://github.com/python-gitlab/python-gitlab/commit/e1ad93df90e80643866611fe52bd5c59428e7a88))
+
+## v3.3.0 (2022-03-28)
+### Feature
+* **object:** Add pipeline test report summary support ([`a97e0cf`](https://github.com/python-gitlab/python-gitlab/commit/a97e0cf81b5394b3a2b73d927b4efe675bc85208))
+
+### Fix
+* Support RateLimit-Reset header ([`4060146`](https://github.com/python-gitlab/python-gitlab/commit/40601463c78a6f5d45081700164899b2559b7e55))
+
+### Documentation
+* Fix typo and incorrect style ([`2828b10`](https://github.com/python-gitlab/python-gitlab/commit/2828b10505611194bebda59a0e9eb41faf24b77b))
+* Add pipeline test report summary support ([`d78afb3`](https://github.com/python-gitlab/python-gitlab/commit/d78afb36e26f41d727dee7b0952d53166e0df850))
+* **chore:** Include docs .js files in sdist ([`3010b40`](https://github.com/python-gitlab/python-gitlab/commit/3010b407bc9baabc6cef071507e8fa47c0f1624d))
+
+## v3.2.0 (2022-02-28)
+### Feature
+* **merge_request_approvals:** Add support for deleting MR approval rules ([`85a734f`](https://github.com/python-gitlab/python-gitlab/commit/85a734fec3111a4a5c4f0ddd7cb36eead96215e9))
+* **artifacts:** Add support for project artifacts delete API ([`c01c034`](https://github.com/python-gitlab/python-gitlab/commit/c01c034169789e1d20fd27a0f39f4c3c3628a2bb))
+* **mixins:** Allow deleting resources without IDs ([`0717517`](https://github.com/python-gitlab/python-gitlab/commit/0717517212b616cfd52cfd38dd5c587ff8f9c47c))
+* **objects:** Add a complete artifacts manager ([`c8c2fa7`](https://github.com/python-gitlab/python-gitlab/commit/c8c2fa763558c4d9906e68031a6602e007fec930))
+
+### Fix
+* **services:** Use slug for id_attr instead of custom methods ([`e30f39d`](https://github.com/python-gitlab/python-gitlab/commit/e30f39dff5726266222b0f56c94f4ccfe38ba527))
+* Remove custom `delete` method for labels ([`0841a2a`](https://github.com/python-gitlab/python-gitlab/commit/0841a2a686c6808e2f3f90960e529b26c26b268f))
+
+### Documentation
+* Enable gitter chat directly in docs ([`bd1ecdd`](https://github.com/python-gitlab/python-gitlab/commit/bd1ecdd5ad654b01b34e7a7a96821cc280b3ca67))
+* Add delete methods for runners and project artifacts ([`5e711fd`](https://github.com/python-gitlab/python-gitlab/commit/5e711fdb747fb3dcde1f5879c64dfd37bf25f3c0))
+* Add retry_transient infos ([`bb1f054`](https://github.com/python-gitlab/python-gitlab/commit/bb1f05402887c78f9898fbd5bd66e149eff134d9))
+* Add transient errors retry info ([`b7a1266`](https://github.com/python-gitlab/python-gitlab/commit/b7a126661175a3b9b73dbb4cb88709868d6d871c))
+* **artifacts:** Deprecate artifacts() and artifact() methods ([`64d01ef`](https://github.com/python-gitlab/python-gitlab/commit/64d01ef23b1269b705350106d8ddc2962a780dce))
+* Revert "chore: add temporary banner for v3" ([#1864](https://github.com/python-gitlab/python-gitlab/issues/1864)) ([`7a13b9b`](https://github.com/python-gitlab/python-gitlab/commit/7a13b9bfa4aead6c731f9a92e0946dba7577c61b))
+
+## v3.1.1 (2022-01-28)
+### Fix
+* **cli:** Make 'per_page' and 'page' type explicit ([`d493a5e`](https://github.com/python-gitlab/python-gitlab/commit/d493a5e8685018daa69c92e5942cbe763e5dac62))
+* **cli:** Make 'timeout' type explicit ([`bbb7df5`](https://github.com/python-gitlab/python-gitlab/commit/bbb7df526f4375c438be97d8cfa0d9ea9d604e7d))
+* **cli:** Allow custom methods in managers ([`8dfed0c`](https://github.com/python-gitlab/python-gitlab/commit/8dfed0c362af2c5e936011fd0b488b8b05e8a8a0))
+* **objects:** Make resource access tokens and repos available in CLI ([`e0a3a41`](https://github.com/python-gitlab/python-gitlab/commit/e0a3a41ce60503a25fa5c26cf125364db481b207))
+
+### Documentation
+* Enhance release docs for CI_JOB_TOKEN usage ([`5d973de`](https://github.com/python-gitlab/python-gitlab/commit/5d973de8a5edd08f38031cf9be2636b0e12f008d))
+* **changelog:** Add missing changelog items ([`01755fb`](https://github.com/python-gitlab/python-gitlab/commit/01755fb56a5330aa6fa4525086e49990e57ce50b))
+
 ## v3.1.0 (2022-01-14)
 ### Feature
 * add support for Group Access Token API ([`c01b7c4`](https://github.com/python-gitlab/python-gitlab/commit/c01b7c494192c5462ec673848287ef2a5c9bd737))

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
 include COPYING AUTHORS CHANGELOG.md requirements*.txt
 include tox.ini
 recursive-include tests *
-recursive-include docs *j2 *.md *.py *.rst api/*.rst Makefile make.bat
+recursive-include docs *j2 *.js *.md *.py *.rst api/*.rst Makefile make.bat
diff --git a/README.rst b/README.rst
@@ -98,8 +98,14 @@ https://github.com/python-gitlab/python-gitlab/issues.
 Gitter Community Chat
 ---------------------

-There is a `gitter <https://gitter.im/python-gitlab/Lobby>`_ community chat
-available at https://gitter.im/python-gitlab/Lobby
+We have a `gitter <https://gitter.im/python-gitlab/Lobby>`_ community chat
+available at https://gitter.im/python-gitlab/Lobby, which you can also
+directly access via the Open Chat button below.
+
+If you have a simple question, the community might be able to help already,
+without you opening an issue. If you regularly use python-gitlab, we also
+encourage you to join and participate. You might discover new ideas and
+use cases yourself!

 Documentation
 -------------

diff --git a/docs/_static/js/gitter.js b/docs/_static/js/gitter.js
@@ -0,0 +1,3 @@
+((window.gitter = {}).chat = {}).options = {
+  room: 'python-gitlab/Lobby'
+};
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -421,8 +421,9 @@ GitLab server can sometimes return a transient HTTP error.
 python-gitlab can automatically retry in such case, when
 ``retry_transient_errors`` argument is set to ``True``.  When enabled,
 HTTP error codes 500 (Internal Server Error), 502 (502 Bad Gateway),
-503 (Service Unavailable), and 504 (Gateway Timeout) are retried.  By
-default an exception is raised for these errors.
+503 (Service Unavailable), and 504 (Gateway Timeout) are retried. It will retry until reaching
+the `max_retries` value. By default, `retry_transient_errors` is set to `False` and an exception
+is raised for these errors.

 .. code-block:: python


diff --git a/docs/conf.py b/docs/conf.py
@@ -121,10 +121,7 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-    "announcement": "⚠ python-gitlab 3.0.0 has been released with several "
-    "<a href='changelog.html#breaking'>breaking changes</a>.",
-}
+# html_theme_options = {}

 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -148,7 +145,15 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ["_static"]
+
+html_js_files = [
+    "js/gitter.js",
+    (
+        "https://sidecar.gitter.im/dist/sidecar.v1.js",
+        {"async": "async", "defer": "defer"},
+    ),
+]

 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

diff --git a/docs/gl_objects/applications.rst b/docs/gl_objects/applications.rst
@@ -22,7 +22,7 @@ List all OAuth applications::

 Create an application::

-    gl.applications.create({'name': 'your_app', 'redirect_uri': 'http://application.url', 'scopes': ['api']})
+    gl.applications.create({'name': 'your_app', 'redirect_uri': 'http://application.url', 'scopes': 'read_user openid profile email'})

 Delete an applications::


diff --git a/docs/gl_objects/deploy_tokens.rst b/docs/gl_objects/deploy_tokens.rst
@@ -54,6 +54,10 @@ List the deploy tokens for a project::

    deploy_tokens = project.deploytokens.list()

+Get a deploy token for a project by id::
+
+    deploy_token = project.deploytokens.get(deploy_token_id)
+
 Create a new deploy token to access registry images of a project:

 In addition to required parameters ``name`` and ``scopes``, this method accepts
@@ -107,6 +111,10 @@ List the deploy tokens for a group::

    deploy_tokens = group.deploytokens.list()

+Get a deploy token for a group by id::
+
+    deploy_token = group.deploytokens.get(deploy_token_id)
+
 Create a new deploy token to access all repositories of all projects in a group:

 In addition to required parameters ``name`` and ``scopes``, this method accepts