Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.2.0 #2886

Merged
merged 6 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 14 additions & 8 deletions DEPLOY.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
## Upload a new version to PyPI

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

1. Run `manage.py`
1. Run `scripts/prepare_release.sh`

```bash
./manage.sh publish
Next version number? (previous: 'XXX')
./scripts/prepare_release.sh
```

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

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)
3. Commit these changes and create a pull request.

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.
4. After merging those changes into `main` branch, create a new Github [release](https://github.com/PyGithub/PyGithub/releases):
- Choose the merge commit in `main`.
- Choose a new tag with release version prefixed with `v`, e.g. `v2.2.0`.
- Add the same release note from `doc/changes.rst`.

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

5. Once the PyPi release workflow completes, a new version will appear on [PyPI](https://pypi.org/project/PyGithub/#history) shortly.
56 changes: 54 additions & 2 deletions doc/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Change log
Stable versions
~~~~~~~~~~~~~~~

Version 2.2.0 ()
-----------------------------------
Version 2.2.0 (January 28, 2024)
--------------------------------

Breaking Changes
^^^^^^^^^^^^^^^^
Expand All @@ -27,6 +27,58 @@ does not support the ``len()`` method. Use the ``totalCount`` property instead:
commits = repo.compare("v0.6", "v0.7").commits
no_of_commits = commits.totalCount


New features
^^^^^^^^^^^^

* Add support to call GraphQL API

Improvements
^^^^^^^^^^^^

* Add parent_team_id, maintainers and notification_setting for creating and updating teams. (#2863) (49d07d16)
* Add support for issue reactions summary (#2866) (cc4c5269)
* Support for DependabotAlert APIs (#2879) (14af7051)
* Derive GraphQL URL from base_url (#2880) (d0caa3c3)
* Make ``Repository.compare().commits`` return paginated list (#2882) (2d284d1e)
* Add missing branch protection fields (#2873) (e47c153b)
* Add ``include_all_branches`` to ``create_repo_from_template`` of ``AuthenticatedUser`` and ``Organization`` (#2871) (34c4642e)
* Add and update organisation dependabot secrets (#2316) (603896f4)
* Add missing params to ``Organization.create_repo`` (#2700) (9c61a2a4)
* Update allowed values for ``Repository`` collaborator permissions (#1996) (b5b66da8)
* Support editing PullRequestReview (#2851) (b1c4c561)
* Update attributes after calling ``PullRequestReview.dismiss`` (#2854) (6f3d714c)
* Add ``request_cve`` on ``RepositoryAdvisories`` (#2855) (41b617b7)
* Filter collaborators of a repository by permissions (#2792) (702c127a)
* Set pull request to auto merge via GraphQL API (#2816) (232df79a)
* Support Environment Variables and Secrets (#2848) (7df97398)
* Update workflow.get_runs & pullrequest.add_to_assignees function signature (#2799) (26eedbb0)
* Add ``GithubObject.last_modified_datetime`` to have ``last_modified`` as a ``datetime`` (#2772) (e7ce8189)
* Add support for global advisories and unify some shared logic with repository advisories (#2702) (c8b4fcbe)
* Add internal as valid Repository visibility value (#2806) (d4a5a40f)
* Add support for issue comments reactions summary (#2813) (67397491)

Bug Fixes
^^^^^^^^^

* Add a bunch of missing urllib.parse.quote calls (#1976) (13194be2)
* Fix Variable and Secret URL (#2835) (aa763431)

Maintenance
^^^^^^^^^^^

* Update the class name for NetrcAuth in the examples (#2860) (2f44b2e8)
* Move build to PEP517 (#2800) (c589bf9e)
* Use new type assert functions in ``Repository`` (#2798) (2783e671)
* PyTest: Move config to pyproject.toml (#2859) (61fb728b)
* codespell: ignore-words-list (#2858) (dcf6d8a1)
* Improve fix-headers.py script (#2728) (a48c37fa)
* Remove dependency on python-dateutil (#2804) (ab131a2f)
* CI: update precommit & apply (#2600) (d92cfba2)
* Fix parameter order according to Version 2.1.0 (#2786) (dc37d5c1)
* Add missing GitHub classes to docs (#2783) (9af9b6e5)
* Fix mypy error with urllib3>=2.0.0a1 by ignoring (#2779) (64b1cdea)

Version 2.1.1 (September 29, 2023)
-----------------------------------

Expand Down
1 change: 1 addition & 0 deletions github/AdvisoryBase.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Joseph Henrich <crimsonknave@gmail.com> #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/AdvisoryVulnerabilityPackage.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
# Copyright 2023 Jonathan Leitschuh <jonathan.leitschuh@gmail.com> #
# Copyright 2023 Joseph Henrich <crimsonknave@gmail.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/AuthenticatedUser.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
# Copyright 2023 Mark Amery <markamery@btinternet.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2023 chantra <chantra@users.noreply.github.com> #
# Copyright 2024 Oskar Jansson <56458534+janssonoskar@users.noreply.github.com>#
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/Branch.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
# Copyright 2023 Thomas Devoogdt <thomas@devoogdt.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2023 terenho <33275803+terenho@users.noreply.github.com> #
# Copyright 2024 Benjamin K <53038537+treee111@users.noreply.github.com> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/BranchProtection.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2024 Benjamin K <53038537+treee111@users.noreply.github.com> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/Comparison.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
22 changes: 22 additions & 0 deletions github/DependabotAlert.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
############################ Copyrights and license ############################
# #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################

from __future__ import annotations

from datetime import datetime
Expand Down
22 changes: 22 additions & 0 deletions github/DependabotAlertAdvisory.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
############################ Copyrights and license ############################
# #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################

from __future__ import annotations

from typing import TYPE_CHECKING, Any
Expand Down
22 changes: 22 additions & 0 deletions github/DependabotAlertDependency.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
############################ Copyrights and license ############################
# #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################

from __future__ import annotations

from typing import Any
Expand Down
22 changes: 22 additions & 0 deletions github/DependabotAlertVulnerability.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
############################ Copyrights and license ############################
# #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################

from __future__ import annotations

from typing import TYPE_CHECKING, Any
Expand Down
1 change: 1 addition & 0 deletions github/EnterpriseConsumedLicenses.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2023 YugoHino <henom06@gmail.com> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/GlobalAdvisory.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Joseph Henrich <crimsonknave@gmail.com> #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
1 change: 1 addition & 0 deletions github/Issue.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Nicolas Schweitzer <nicolas.schweitzer@datadoghq.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2024 Malik Shahzad Muzaffar <shahzad.malik.muzaffar@cern.ch> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
5 changes: 5 additions & 0 deletions github/Organization.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,12 @@
# Copyright 2023 Mark Amery <markamery@btinternet.com> #
# Copyright 2023 Mauricio Alejandro Martínez Pacheco <mauricio.martinez@premise.com>#
# Copyright 2023 Mauricio Alejandro Martínez Pacheco <n_othing@hotmail.com> #
# Copyright 2023 Oliver Mannion <125105+tekumara@users.noreply.github.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2024 Andrii Kezikov <cheshirez@gmail.com> #
# Copyright 2024 Mohamed Mostafa <112487260+mohy01@users.noreply.github.com> #
# Copyright 2024 Oskar Jansson <56458534+janssonoskar@users.noreply.github.com>#
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
Expand Down
22 changes: 22 additions & 0 deletions github/OrganizationDependabotAlert.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
############################ Copyrights and license ############################
# #
# Copyright 2024 Thomas Cooper <coopernetes@proton.me> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################

from __future__ import annotations

from typing import Any
Expand Down