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

#1671 Remove unreleased MAINTAIN and TRIAGE permissions added during GitHub outage #1674

Merged
merged 1 commit into from
Jun 12, 2023

Conversation

PierreBtz
Copy link
Contributor

Description

Permissions added to the enum in #1672 do not make sense anymore since the Github Rest API change was roll-backed with no intention of re-introducing this change (as per: #1671 (comment)).

In order to clean things up, this is a partial revert of #1672 only keeping the fallback logic.

I intentionally deleted the enum members instead of deprecating them, I don't really see a use case where somebody would have used the new enum values since the library was released around the same time Github rollbacked their changes.

Before submitting a PR:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details. -> SEE MY COMMENT above!
  • Add JavaDocs and other comments explaining the behavior.
  • When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

After the rollback of the Github Rest API
@codecov
Copy link

codecov bot commented Jun 7, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (4cbae90) 79.94% compared to head (7ce760d) 79.93%.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1674      +/-   ##
============================================
- Coverage     79.94%   79.93%   -0.01%     
  Complexity     2208     2208              
============================================
  Files           212      212              
  Lines          6690     6688       -2     
  Branches        364      364              
============================================
- Hits           5348     5346       -2     
  Misses         1128     1128              
  Partials        214      214              
Impacted Files Coverage Δ
...main/java/org/kohsuke/github/GHPermissionType.java 100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@jglick jglick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change looks very good to me.

The change to add MAINTAIN and TRIAGE permissions was never released. The github-api-1.315 tag is placed on commit 5be032e May 31, 2023, while the addition of MAINTAIN and TRIAGE permissions was done on June 5, 2023 in commit 49a93bf . No compatibility impact because the new enumerations were never released.

@MarkEWaite
Copy link
Contributor

MarkEWaite commented Jun 7, 2023

It might help the readers of the changelog if the title of the pull request specifically mentioned the permissions being removed so that they see the "add" line and then the "remove" line in the same changelog.

Possible suggestion?

== Remove unreleased MAINTAIN and TRIAGE permissions added during GitHub outage

@PierreBtz PierreBtz changed the title #1671 Cleanup non existing permissions #1671 Remove unreleased MAINTAIN and TRIAGE permissions added during GitHub outage Jun 8, 2023
@PierreBtz
Copy link
Contributor Author

Wasn't aware that the change didn't even get released, it definitely answers my question about backward compatibility :)

I followed your suggestion and updated the title of this PR to be more helpful.

@bitwiseman bitwiseman merged commit 406fc7e into hub4j:main Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants