Skip to content

Commit 7e7653f

Browse files
EnricoMiEnricoMi
authored
Release v2.2.0 (PyGithub#2886)
1 parent 49d07d1 commit 7e7653f

35 files changed

+247
-56
lines changed

‎DEPLOY.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
## Upload a new version to PyPI
22

3-
Github workflow (`.github/workflows/python-publish.yml`) will push tagged commits to PyPI. Here are the steps:
3+
Github [PyPi release](.github/workflows/pypi-release.yml) workflow will push tagged commits to PyPI. Here are the steps:
44

5-
1. Run `manage.py`
5+
1. Run `scripts/prepare_release.sh`
66

77
```bash
8-
./manage.sh publish
9-
Next version number? (previous: 'XXX')
8+
./scripts/prepare_release.sh
109
```
1110

12-
2. Give the new version number based on previous version (Use semantic versioning)
11+
2. Complete the changes in `doc/changes.rst`:
12+
- Replace `Version ?.?.?` with the release version.
13+
- Organize commits into sub-sections like "New features" or "Bug Fixes", see earlier releases for inspiration.
1314

14-
3. Create a new Github [release](https://github.com/PyGithub/PyGithub/releases) from the tag that has just been committed, with the same release note from `doc/changes.rst`. This step is the hook that will trigger the workflow. (also needed for some web spiders for changelog parsing)
15+
3. Commit these changes and create a pull request.
1516

16-
4. Now the push will be on hold until you press Enter. Manually inspect the changelog (`doc/changes.rst`) to make changes if necessary. Once you are sure, go back and press Enter.
17+
4. After merging those changes into `main` branch, create a new Github [release](https://github.com/PyGithub/PyGithub/releases):
18+
- Choose the merge commit in `main`.
19+
- Choose a new tag with release version prefixed with `v`, e.g. `v2.2.0`.
20+
- Add the same release note from `doc/changes.rst`.
1721

18-
5. Once the `python-publish` workflow completes, a new version will appear on [PyPI](https://pypi.org/project/PyGithub/#history) shortly.
22+
Creating the release also creates the tag chosen, which will trigger the PyPi release workflow.
23+
24+
5. Once the PyPi release workflow completes, a new version will appear on [PyPI](https://pypi.org/project/PyGithub/#history) shortly.

‎doc/changes.rst

+54-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Change log
44
Stable versions
55
~~~~~~~~~~~~~~~
66

7-
Version 2.2.0 ()
8-
-----------------------------------
7+
Version 2.2.0 (January 28, 2024)
8+
--------------------------------
99

1010
Breaking Changes
1111
^^^^^^^^^^^^^^^^
@@ -27,6 +27,58 @@ does not support the ``len()`` method. Use the ``totalCount`` property instead:
2727
commits = repo.compare("v0.6", "v0.7").commits
2828
no_of_commits = commits.totalCount
2929
30+
31+
New features
32+
^^^^^^^^^^^^
33+
34+
* Add support to call GraphQL API
35+
36+
Improvements
37+
^^^^^^^^^^^^
38+
39+
* Add parent_team_id, maintainers and notification_setting for creating and updating teams. (#2863) (49d07d16)
40+
* Add support for issue reactions summary (#2866) (cc4c5269)
41+
* Support for DependabotAlert APIs (#2879) (14af7051)
42+
* Derive GraphQL URL from base_url (#2880) (d0caa3c3)
43+
* Make ``Repository.compare().commits`` return paginated list (#2882) (2d284d1e)
44+
* Add missing branch protection fields (#2873) (e47c153b)
45+
* Add ``include_all_branches`` to ``create_repo_from_template`` of ``AuthenticatedUser`` and ``Organization`` (#2871) (34c4642e)
46+
* Add and update organisation dependabot secrets (#2316) (603896f4)
47+
* Add missing params to ``Organization.create_repo`` (#2700) (9c61a2a4)
48+
* Update allowed values for ``Repository`` collaborator permissions (#1996) (b5b66da8)
49+
* Support editing PullRequestReview (#2851) (b1c4c561)
50+
* Update attributes after calling ``PullRequestReview.dismiss`` (#2854) (6f3d714c)
51+
* Add ``request_cve`` on ``RepositoryAdvisories`` (#2855) (41b617b7)
52+
* Filter collaborators of a repository by permissions (#2792) (702c127a)
53+
* Set pull request to auto merge via GraphQL API (#2816) (232df79a)
54+
* Support Environment Variables and Secrets (#2848) (7df97398)
55+
* Update workflow.get_runs & pullrequest.add_to_assignees function signature (#2799) (26eedbb0)
56+
* Add ``GithubObject.last_modified_datetime`` to have ``last_modified`` as a ``datetime`` (#2772) (e7ce8189)
57+
* Add support for global advisories and unify some shared logic with repository advisories (#2702) (c8b4fcbe)
58+
* Add internal as valid Repository visibility value (#2806) (d4a5a40f)
59+
* Add support for issue comments reactions summary (#2813) (67397491)
60+
61+
Bug Fixes
62+
^^^^^^^^^
63+
64+
* Add a bunch of missing urllib.parse.quote calls (#1976) (13194be2)
65+
* Fix Variable and Secret URL (#2835) (aa763431)
66+
67+
Maintenance
68+
^^^^^^^^^^^
69+
70+
* Update the class name for NetrcAuth in the examples (#2860) (2f44b2e8)
71+
* Move build to PEP517 (#2800) (c589bf9e)
72+
* Use new type assert functions in ``Repository`` (#2798) (2783e671)
73+
* PyTest: Move config to pyproject.toml (#2859) (61fb728b)
74+
* codespell: ignore-words-list (#2858) (dcf6d8a1)
75+
* Improve fix-headers.py script (#2728) (a48c37fa)
76+
* Remove dependency on python-dateutil (#2804) (ab131a2f)
77+
* CI: update precommit & apply (#2600) (d92cfba2)
78+
* Fix parameter order according to Version 2.1.0 (#2786) (dc37d5c1)
79+
* Add missing GitHub classes to docs (#2783) (9af9b6e5)
80+
* Fix mypy error with urllib3>=2.0.0a1 by ignoring (#2779) (64b1cdea)
81+
3082
Version 2.1.1 (September 29, 2023)
3183
-----------------------------------
3284

‎github/AdvisoryBase.py

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
# #
33
# Copyright 2023 Enrico Minack <[email protected]> #
44
# Copyright 2023 Joseph Henrich <[email protected]> #
5+
# Copyright 2024 Thomas Cooper <[email protected]> #
56
# #
67
# This file is part of PyGithub. #
78
# http://pygithub.readthedocs.io/ #

‎github/AdvisoryVulnerabilityPackage.py

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
# Copyright 2023 Jonathan Leitschuh <[email protected]> #
2020
# Copyright 2023 Joseph Henrich <[email protected]> #
2121
# Copyright 2023 Trim21 <[email protected]> #
22+
# Copyright 2024 Thomas Cooper <[email protected]> #
2223
# #
2324
# This file is part of PyGithub. #
2425
# http://pygithub.readthedocs.io/ #

‎github/AuthenticatedUser.py

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
# Copyright 2023 Mark Amery <[email protected]> #
4848
# Copyright 2023 Trim21 <[email protected]> #
4949
# Copyright 2023 chantra <[email protected]> #
50+
# Copyright 2024 Oskar Jansson <[email protected]>#
5051
# #
5152
# This file is part of PyGithub. #
5253
# http://pygithub.readthedocs.io/ #

‎github/Branch.py

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
# Copyright 2023 Thomas Devoogdt <[email protected]> #
2727
# Copyright 2023 Trim21 <[email protected]> #
2828
# Copyright 2023 terenho <[email protected]> #
29+
# Copyright 2024 Benjamin K <[email protected]> #
2930
# #
3031
# This file is part of PyGithub. #
3132
# http://pygithub.readthedocs.io/ #

‎github/BranchProtection.py

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
# Copyright 2023 Enrico Minack <[email protected]> #
99
# Copyright 2023 Jirka Borovec <[email protected]> #
1010
# Copyright 2023 Trim21 <[email protected]> #
11+
# Copyright 2024 Benjamin K <[email protected]> #
1112
# #
1213
# This file is part of PyGithub. #
1314
# http://pygithub.readthedocs.io/ #

‎github/Comparison.py

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
# Copyright 2023 Enrico Minack <[email protected]> #
1515
# Copyright 2023 Jirka Borovec <[email protected]> #
1616
# Copyright 2023 Trim21 <[email protected]> #
17+
# Copyright 2024 Enrico Minack <[email protected]> #
1718
# #
1819
# This file is part of PyGithub. #
1920
# http://pygithub.readthedocs.io/ #

‎github/DependabotAlert.py

+22
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
############################ Copyrights and license ############################
2+
# #
3+
# Copyright 2024 Thomas Cooper <[email protected]> #
4+
# #
5+
# This file is part of PyGithub. #
6+
# http://pygithub.readthedocs.io/ #
7+
# #
8+
# PyGithub is free software: you can redistribute it and/or modify it under #
9+
# the terms of the GNU Lesser General Public License as published by the Free #
10+
# Software Foundation, either version 3 of the License, or (at your option) #
11+
# any later version. #
12+
# #
13+
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
14+
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
15+
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
16+
# details. #
17+
# #
18+
# You should have received a copy of the GNU Lesser General Public License #
19+
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
20+
# #
21+
################################################################################
22+
123
from __future__ import annotations
224

325
from datetime import datetime

‎github/DependabotAlertAdvisory.py

+22
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
############################ Copyrights and license ############################
2+
# #
3+
# Copyright 2024 Thomas Cooper <[email protected]> #
4+
# #
5+
# This file is part of PyGithub. #
6+
# http://pygithub.readthedocs.io/ #
7+
# #
8+
# PyGithub is free software: you can redistribute it and/or modify it under #
9+
# the terms of the GNU Lesser General Public License as published by the Free #
10+
# Software Foundation, either version 3 of the License, or (at your option) #
11+
# any later version. #
12+
# #
13+
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
14+
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
15+
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
16+
# details. #
17+
# #
18+
# You should have received a copy of the GNU Lesser General Public License #
19+
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
20+
# #
21+
################################################################################
22+
123
from __future__ import annotations
224

325
from typing import TYPE_CHECKING, Any

‎github/DependabotAlertDependency.py

+22
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
############################ Copyrights and license ############################
2+
# #
3+
# Copyright 2024 Thomas Cooper <[email protected]> #
4+
# #
5+
# This file is part of PyGithub. #
6+
# http://pygithub.readthedocs.io/ #
7+
# #
8+
# PyGithub is free software: you can redistribute it and/or modify it under #
9+
# the terms of the GNU Lesser General Public License as published by the Free #
10+
# Software Foundation, either version 3 of the License, or (at your option) #
11+
# any later version. #
12+
# #
13+
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
14+
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
15+
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
16+
# details. #
17+
# #
18+
# You should have received a copy of the GNU Lesser General Public License #
19+
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
20+
# #
21+
################################################################################
22+
123
from __future__ import annotations
224

325
from typing import Any

‎github/DependabotAlertVulnerability.py

+22
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
############################ Copyrights and license ############################
2+
# #
3+
# Copyright 2024 Thomas Cooper <[email protected]> #
4+
# #
5+
# This file is part of PyGithub. #
6+
# http://pygithub.readthedocs.io/ #
7+
# #
8+
# PyGithub is free software: you can redistribute it and/or modify it under #
9+
# the terms of the GNU Lesser General Public License as published by the Free #
10+
# Software Foundation, either version 3 of the License, or (at your option) #
11+
# any later version. #
12+
# #
13+
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
14+
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
15+
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
16+
# details. #
17+
# #
18+
# You should have received a copy of the GNU Lesser General Public License #
19+
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
20+
# #
21+
################################################################################
22+
123
from __future__ import annotations
224

325
from typing import TYPE_CHECKING, Any

‎github/EnterpriseConsumedLicenses.py

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
# Copyright 2023 Enrico Minack <[email protected]> #
1717
# Copyright 2023 Trim21 <[email protected]> #
1818
# Copyright 2023 YugoHino <[email protected]> #
19+
# Copyright 2024 Enrico Minack <[email protected]> #
1920
# #
2021
# This file is part of PyGithub. #
2122
# http://pygithub.readthedocs.io/ #

‎github/GlobalAdvisory.py

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
# #
33
# Copyright 2023 Enrico Minack <[email protected]> #
44
# Copyright 2023 Joseph Henrich <[email protected]> #
5+
# Copyright 2024 Thomas Cooper <[email protected]> #
56
# #
67
# This file is part of PyGithub. #
78
# http://pygithub.readthedocs.io/ #

‎github/Issue.py

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
# Copyright 2023 Jirka Borovec <[email protected]> #
3636
# Copyright 2023 Nicolas Schweitzer <[email protected]> #
3737
# Copyright 2023 Trim21 <[email protected]> #
38+
# Copyright 2024 Malik Shahzad Muzaffar <[email protected]> #
3839
# #
3940
# This file is part of PyGithub. #
4041
# http://pygithub.readthedocs.io/ #

‎github/Organization.py

+5
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@
5050
# Copyright 2023 Mark Amery <[email protected]> #
5151
# Copyright 2023 Mauricio Alejandro Martínez Pacheco <[email protected]>#
5252
# Copyright 2023 Mauricio Alejandro Martínez Pacheco <[email protected]> #
53+
# Copyright 2023 Oliver Mannion <[email protected]> #
5354
# Copyright 2023 Trim21 <[email protected]> #
55+
# Copyright 2024 Andrii Kezikov <[email protected]> #
56+
# Copyright 2024 Mohamed Mostafa <[email protected]> #
57+
# Copyright 2024 Oskar Jansson <[email protected]>#
58+
# Copyright 2024 Thomas Cooper <[email protected]> #
5459
# #
5560
# This file is part of PyGithub. #
5661
# http://pygithub.readthedocs.io/ #

‎github/OrganizationDependabotAlert.py

+22
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
############################ Copyrights and license ############################
2+
# #
3+
# Copyright 2024 Thomas Cooper <[email protected]> #
4+
# #
5+
# This file is part of PyGithub. #
6+
# http://pygithub.readthedocs.io/ #
7+
# #
8+
# PyGithub is free software: you can redistribute it and/or modify it under #
9+
# the terms of the GNU Lesser General Public License as published by the Free #
10+
# Software Foundation, either version 3 of the License, or (at your option) #
11+
# any later version. #
12+
# #
13+
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
14+
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
15+
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
16+
# details. #
17+
# #
18+
# You should have received a copy of the GNU Lesser General Public License #
19+
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
20+
# #
21+
################################################################################
22+
123
from __future__ import annotations
224

325
from typing import Any

0 commit comments

Comments
 (0)