Add `make_latest` to `GitRelease.update_release` #2788

fb929 · 2023-10-11T04:07:21Z

The problem:
def "update_release" can not make release as "latest"
How solving the problem:
adding optional parameter "make_latest", from original api doc: https://docs.github.com/en/free-pro-team@latest/rest/releases/releases?apiVersion=2022-11-28#update-a-release--code-samples

codecov-commenter · 2023-10-11T04:09:53Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (9af9b6e) 96.73% compared to head (15283a6) 96.72%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2788      +/-   ##
==========================================
- Coverage   96.73%   96.72%   -0.02%     
==========================================
  Files         139      139              
  Lines       14185    14188       +3     
==========================================
+ Hits        13722    13723       +1     
- Misses        463      465       +2

Files	Coverage Δ
github/GitRelease.py	`97.67% <33.33%> (-1.15%)`	⬇️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

trim21 · 2023-10-21T16:17:26Z

can you also update document link in docstring? current link is out of data.

pfarrell · 2023-12-20T15:54:48Z

@fb929 I was just about to submit a PR to do exactly this.
Are you planning to complete this PR? This is a very feature I needed and had to implement by calling the github rest api directly. I'd much prefer to have support in PyGithub.

EnricoMi

While you are here, can you please add discussion_category_name as well?

EnricoMi · 2023-12-22T14:30:56Z

github/GitRelease.py

            "prerelease": prerelease,
        }
+        if make_latest is not NotSet:
+            assert isinstance(make_latest, bool), make_latest


documentation says, this is a string

Suggested change

assert isinstance(make_latest, bool), make_latest

assert make_latest in ["true", "false", "legacy"], make_latest

EnricoMi · 2023-12-22T14:35:02Z

@pfarrell feel free to fork @fb929's repo and branch and create a new PR to finish this. This way, @fb929's contribution is credited and we get this over the finish line.

EnricoMi · 2023-12-22T14:35:41Z

Looks like message has been renamed to body. This should be reflected in another PR to prevent this from breaking in the future. https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28

EnricoMi · 2024-01-28T15:52:08Z

github/GitRelease.py

        message: str,
        draft: bool = False,
        prerelease: bool = False,
+        make_latest: Opt[bool] = NotSet,


Adding this here may break user code, can you add this at the end of the argument list?

EnricoMi · 2024-01-28T15:53:04Z

@pfarrell @fb929 can we get this over the finish line?

PyGithub#2788

treee111 · 2024-01-30T21:30:53Z

I tackled the PR review of this PR in the linked PR. @trim21 and @EnricoMi feel free to review.

Looks like message has been renamed to body. This should be reflected in another PR to prevent this from breaking in the future. https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28

we already send/post that as body to the Github API and have message only as input to PyGithub if I am correct? So no need for adjustment (because that would break user code). See:

PyGithub/github/GitRelease.py

Lines 204 to 210 in 7e7653f

    
           post_parameters = { 
        
               "tag_name": tag_name, 
        
               "name": name, 
        
               "body": message, 
        
               "draft": draft, 
        
               "prerelease": prerelease, 
        
           }

PyGithub#2788

PyGithub#2788 make_latest is string

pfarrell · 2024-02-03T17:19:00Z

@pfarrell @fb929 can we get this over the finish line?

@EnricoMi, apologies for missing the alerts on this, thanks @@treee111 for picking this up

treee111 · 2024-02-03T18:44:35Z

You are welcome @pfarrell. Feel free to test the coding and comment if it worked for you! Helps the PR getting merged :-)

EnricoMi · 2024-02-04T19:19:11Z

Closed in favour of #2888.

### The problem: - def "update_release" can not make release as "latest" ### How solving the problem: - adding optional parameter "make_latest", from original api doc: https://docs.github.com/en/free-pro-team@latest/rest/releases/releases?apiVersion=2022-11-28#update-a-release--code-samples ### additions - documentation URL has changed - `discussion_category_name` has been added superseds #2788 --------- Co-authored-by: Grigory Efimov <grigory.efimov@gmail.com> Co-authored-by: Enrico Minack <github@enrico.minack.dev>

github/GitRelease.py added "make_latest" option for def "update_release"

15283a6

EnricoMi requested changes Dec 22, 2023

View reviewed changes

EnricoMi reviewed Jan 28, 2024

View reviewed changes

EnricoMi changed the title ~~github/GitRelease.py added "make_latest" option for def "update_release"~~ Add make_latest to GitRelease.update_release Jan 28, 2024

treee111 added a commit to treee111/PyGithub that referenced this pull request Jan 30, 2024

PR review findings of PyGithub#2788

c43bb3f

PyGithub#2788

treee111 mentioned this pull request Jan 30, 2024

Add make_latest to GitRelease.update_release #2888

Merged

treee111 added a commit to treee111/PyGithub that referenced this pull request Jan 31, 2024

PR review findings of PyGithub#2788

7d6cef3

PyGithub#2788

treee111 added a commit to treee111/PyGithub that referenced this pull request Jan 31, 2024

PR review findings of PyGithub#2788

aebe41e

PyGithub#2788

treee111 added a commit to treee111/PyGithub that referenced this pull request Jan 31, 2024

PR review findings of PyGithub#2788

267e1c5

PyGithub#2788 make_latest is string

treee111 mentioned this pull request Feb 1, 2024

Add created and check_suite_id filter for Repository Workflow runs #2891

Merged

EnricoMi closed this Feb 4, 2024

	assert isinstance(make_latest, bool), make_latest
	assert make_latest in ["true", "false", "legacy"], make_latest

Uh oh!

Add make_latest to GitRelease.update_release #2788

Add make_latest to GitRelease.update_release #2788

Uh oh!

Conversation

fb929 commented Oct 11, 2023

Uh oh!

codecov-commenter commented Oct 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

trim21 commented Oct 21, 2023

Uh oh!

pfarrell commented Dec 20, 2023

Uh oh!

EnricoMi left a comment

Choose a reason for hiding this comment

Uh oh!

EnricoMi Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

EnricoMi commented Dec 22, 2023

Uh oh!

EnricoMi commented Dec 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EnricoMi Jan 28, 2024

Choose a reason for hiding this comment

Uh oh!

EnricoMi commented Jan 28, 2024

Uh oh!

treee111 commented Jan 30, 2024

Uh oh!

pfarrell commented Feb 3, 2024

Uh oh!

treee111 commented Feb 3, 2024

Uh oh!

EnricoMi commented Feb 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add `make_latest` to `GitRelease.update_release` #2788

Add `make_latest` to `GitRelease.update_release` #2788

codecov-commenter commented Oct 11, 2023 •

edited

Loading

EnricoMi commented Dec 22, 2023 •

edited

Loading