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

ProjectOptions (public to private) & Project struct (org related fields) fixes #2111

Merged
merged 2 commits into from
Dec 3, 2021
Merged

ProjectOptions (public to private) & Project struct (org related fields) fixes #2111

merged 2 commits into from
Dec 3, 2021

Conversation

DariuszPorowski
Copy link
Contributor

@DariuszPorowski DariuszPorowski commented Sep 28, 2021

This fixes #2110

I've done UATs as well, and all API calls looked good:

  • Update Org Project with new private field
  • Get Org Project (OrganizationPermission and Private presents as expected)
  • Get Repo Project (OrganizationPermission and Private not presents as expected)
  • Get User Project (OrganizationPermission and Private not presents as expected)

@google-cla
Copy link

google-cla bot commented Sep 28, 2021

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added the cla: no label Sep 28, 2021
@DariuszPorowski DariuszPorowski marked this pull request as ready for review September 28, 2021 21:22
@DariuszPorowski
Copy link
Contributor Author

@googlebot I fixed it.

@google-cla google-cla bot added cla: yes Indication that the PR author has signed a Google Contributor License Agreement. and removed cla: no labels Sep 28, 2021
@codecov
Copy link

codecov bot commented Sep 28, 2021

Codecov Report

Merging #2111 (77bc22d) into master (eefa002) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2111   +/-   ##
=======================================
  Coverage   97.77%   97.77%           
=======================================
  Files         111      111           
  Lines        9934     9934           
=======================================
  Hits         9713     9713           
  Misses        154      154           
  Partials       67       67           
Impacted Files Coverage Δ
github/projects.go 96.32% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eefa002...77bc22d. Read the comment docs.

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

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

Thank you, @DariuszPorowski !
LGTM.

Awaiting second LGTM before merging.

This is technically a Breaking API change... however, I'm tempted to declare this one as non-breaking simply because what we are changing was already broken... so in theory, any attempts to use the prior version would have failed.

Thoughts? Is it OK to NOT declare this PR as a breaking APi change (and therefore not have to bump the major version number of this repo at the next release due to this PR alone)?

@willnorris - what is your opinion?

@willnorris
Copy link
Collaborator

Even though this was never working as intended, it's a breaking change in the Go API in that if anyone was calling it, their code would no longer compile now. And since it's been in the wild for 3 years, I feel like it would be more responsible to treat it as a breaking change.

@gmlewis gmlewis added the Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). label Sep 29, 2021
@DariuszPorowski
Copy link
Contributor Author

@gmlewis I agree with @willnorris
Even if it is a change to a valid GitHub API, it changes the entire usage of Go API.

Copy link
Contributor

@cpanato cpanato left a comment

Choose a reason for hiding this comment

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

lgtm
we need to document that in the release notes

@gmlewis
Copy link
Collaborator

gmlewis commented Dec 3, 2021

Thank you, @cpanato - merging.

@gmlewis gmlewis merged commit b913905 into google:master Dec 3, 2021
@DariuszPorowski DariuszPorowski deleted the orgs_projects_struct branch February 8, 2022 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). cla: yes Indication that the PR author has signed a Google Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ProjectOptions has wrong field & Project struct miss Organization related fields
4 participants