You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/changes.rst
+101-6Lines changed: 101 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,107 @@ Change log
4
4
Stable versions
5
5
~~~~~~~~~~~~~~~
6
6
7
+
Version 1.59.0 (June 22, 2023)
8
+
-----------------------------------
9
+
10
+
**Important**
11
+
12
+
This release introduces new way of authentication. All authentication-related arguments ``github.Github(login_or_token=…, password=…, jwt=…, app_auth=…)``
13
+
and ``github.GithubIntegration(integration_id=…, private_key=…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…)`` are replaced by a single ``auth=…`` argument.
14
+
Module ``github.Auth`` provides classes for all supported ways of authentication: ``Login``, ``Token``, ``AppAuth``, ``AppAuthToken``, ``AppInstallationAuth``, ``AppUserAuth``.
15
+
Old arguments are deprecated but continue to work. They are scheduled for removal for version 2.0 release.
16
+
17
+
This project has decided to move all typing information from ``.pyi`` files into the respective ``.py`` source files.
18
+
This will happen gradually over time.
19
+
20
+
**Breaking Changes**
21
+
22
+
* The ``position`` argument in ``github.PullRequest.create_review_comment(position=…)`` has been renamed to ``line``.
23
+
This breaks user code that calls ``create_review_comment`` with keyword argument ``position``. Call with ``line=…`` instead.
24
+
Calling this method with positional arguments is not breaking.
25
+
* The ``jwt_expiry``, ``jwt_issued_at`` and ``jwt_algorithm`` arguments in ``github.GithubIntegration()`` have changed their position.
26
+
User code calling ``github.GithubIntegration(…)`` with these arguments as positional arguments breaks.
27
+
Please use keyword arguments: ``github.GithubIntegration(…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…)``.
28
+
* The ``since`` argument in ``github.PullRequest.get_review_comments(…)`` has changed position.``
29
+
User code calling ``github.PullRequest.get_review_comments(…)`` with this argument as positional argument breaks.
30
+
Please use keyword argument: ``github.PullRequest.get_review_comments(since=…)``.
31
+
32
+
**Deprecations**
33
+
34
+
* The use of ``github.Github(login_or_token=…)`` is deprecated, use ``github.Github(auth=github.Auth.Login(…))`` or ``github.Github(auth=github.Auth.Token(…))`` instead.
35
+
* The use of ``github.Github(password=…)`` is deprecated, use ``github.Github(auth=github.Auth.Login(…))`` instead.
36
+
* The use of ``github.Github(jwt=…)`` is deprecated, use ``github.Github(auth=github.AppAuth(…))`` or ``github.Github(auth=github.AppAuthToken(…))`` instead.
37
+
* The use of ``github.Github(app_auth=…)`` is deprecated, use ``github.Github(auth=github.Auth.AppInstallationAuth(…))`` instead.
38
+
* The use of ``github.GithubIntegration(integration_id=…, private_key=…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…)`` is deprecated, use ``github.GithubIntegration(auth=github.Auth.AppAuth(…))`` instead.
39
+
* The use of ``github.GithubIntegration.create_jwt`` is deprecated, use ``github.Github(auth=github.Auth.AppAuth)``, ``github.Auth.AppAuth.token`` or ``github.Auth.AppAuth.create_jwt(expiration)`` instead.
40
+
* The use of ``AppAuthentication`` is deprecated, use ``github.Auth.AppInstallationAuth`` instead.
41
+
* The use of ``github.Github.get_app()`` without providing argument ``slug`` is deprecated, use ``github.GithubIntegration(auth=github.Auth.AppAuth(…)).get_app()``.
42
+
43
+
**Bug Fixes**
44
+
45
+
* Test and fix UTC issue with AppInstallationAuth (#2561) (ff3b80f8)
46
+
* Make Requester.__createException robust against missing message and body (#2159) (7be3f763)
47
+
* Fix auth issues with `Installation.get_repos` (#2547) (64075120)
48
+
* Fix broken urls in docstrings (#2393) (f82ad61c)
0 commit comments