Add Webhook for Repository ruleset by unamdev0 · Pull Request #3305 · google/go-github

unamdev0 · 2024-10-04T15:25:11Z

Added Repository ruleset event
Fixes#3295

…docs

unamdev0 · 2024-10-04T15:26:45Z

@gmlewis please ignore the previous PR and review this. This PR contains just my code and hasn't been reabased with master branch.
updated RuleSet to Ruleset everywhere, also improved the comment describing the repository ruleset event

gmlewis

I'm going to hold off reviewing this one until comments from the last PR are addressed.
Specifically,

Godocs should always use complete sentences with punctuation so that the auto-generated package documentation formats and reads nicely.

It looks like GitHub ate my other lengthy comment, unfortunately... but the gist of it was that every exported struct needs a Godoc-style comment to explain its purpose and usage for the auto-generated package documentation.

codecov · 2024-10-04T16:34:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.39%. Comparing base (2b8c7fa) to head (e125889).
Report is 154 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #3305 +/- ##
==========================================
- Coverage 97.72% 93.39% -4.33% 
==========================================
Files 153 172 +19 Lines 13390 11909 -1481 ==========================================
- Hits 13085 11123 -1962 - Misses 215 692 +477 - Partials 90 94 +4

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

unamdev0 · 2024-10-04T18:23:56Z

I'm going to hold off reviewing this one until comments from the last PR are addressed.
Specifically,
Godocs should always use complete sentences with punctuation so that the auto-generated package documentation formats and reads nicely.
It looks like GitHub ate my other lengthy comment, unfortunately... but the gist of it was that every exported struct needs a Godoc-style comment to explain its purpose and usage for the auto-generated package documentation.

Got it, will add comments for every new struct added and will let you know

unamdev0 · 2024-10-14T09:18:22Z

@gmlewis please go ahead and review the code, I've added comments for all the new structs generated

gmlewis

Thank you, @unamdev0 !
Just a few linter errors to clean up, please, and a few tweaks, then we should be ready for a second LGTM+Approval from any other contributor to this repo before merging.

unamdev0 · 2024-10-14T14:46:23Z

Done @gmlewis, all the suggestion made have been added and test files have been modified accordingly

gmlewis

It looks like there are a few more linter errors - you can see them in the GitHub user interface, I believe.

gmlewis · 2024-10-14T14:53:31Z

You should also be able to see them locally if you follow step 4 of CONTRIBUTING.md.

unamdev0 · 2024-10-14T15:22:57Z

Hi @gmlewis, I'm not able to see any linting issues shown in github interface, when running script/lint.sh. Other than that,I've made the change that was missed last time

gmlewis · 2024-10-14T15:27:32Z

Ah, to see them locally you probably need to merge the latest master into your PR... but I'll rerun the workflows and see if I can take screenshots for you.

gmlewis · 2024-10-14T15:42:43Z

@unamdev0 - can you see this?
https://github.com/google/go-github/actions/runs/11330493244/job/31508792189?pr=3305

gmlewis

I've gone ahead and made suggestions that should clear up the linter errors.

unamdev0 · 2024-10-14T15:51:59Z

@gmlewis added the suggestions, should I add the changes in generated files manually as well as shown in the github UI?

gmlewis · 2024-10-14T16:37:48Z

@gmlewis added the suggestions, should I add the changes in generated files manually as well as shown in the github UI?

No, you should never edit the auto-generated files. If you find problems in them (which I don't think there are any), then the code that generates them gen-*.go should be modified... but usually, users of this repo can leave maintenance of those up to the maintainers of the repo. Is that what you were asking?

gmlewis · 2024-10-14T16:38:16Z

Can you please push those changes to the suggested changes? I'm not seeing them yet.

unamdev0 · 2024-10-15T04:17:34Z

No, you should never edit the auto-generated files. If you find problems in them (which I don't think there are any), then the code that generates them gen-*.go should be modified... but usually, users of this repo can leave maintenance of those up to the maintainers of the repo. Is that what you were asking?

Oh okay, I've pushed changes with period at the end of comments, and not modified any other file, can you please review once

gmlewis

I'll go ahead and apply these as well.

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

gmlewis · 2024-10-15T20:16:52Z

Bummer. I didn't get the spacing right. working on it...

gmlewis · 2024-10-15T20:22:52Z

@unamdev0 - sorry for all the noise - I was trying to make it so that we wouldn't require more changes from you, but alas I was unsuccessful.

Could you please do this for me again?

git checkout feature/add-repositoryrulesetevent
git pull origin feature/add-repositoryrulesetevent
go generate ./...
git commit -am 'Run latest go generate'
git push origin feature/add-repositoryrulesetevent

unamdev0 · 2024-10-16T09:21:10Z

done @gmlewis

gmlewis

Unit tests still failing. I'll see if I can fix them.

gmlewis

Merging.

Fixes: google#3295.

unamdev0 added 4 commits October 2, 2024 23:52

Added Webhook for Repository ruleset
7749ae9

added test for repository ruleset event
c473ad5

Add RepositoryRulesetEvent methods
f7dd113

improved comment for documentation; replaced with as given in github …
e63118c
…docs

gmlewis requested changes Oct 4, 2024
View reviewed changes

added comment for all the structs created
de53c18

gmlewis requested changes Oct 14, 2024
View reviewed changes

Comment threadgithub/repos_rules.go Outdated
Comment threadgithub/repos_rules.go Outdated
Comment threadgithub/repos_rules.go Outdated

fixed minor bugs and linting errors
ab4bf59

gmlewis requested changes Oct 14, 2024
View reviewed changes

Comment threadgithub/repos_rules.go Outdated

update CodeScanningTools to slice of pointers
7f9928f

gmlewis requested changes Oct 14, 2024
View reviewed changes

Comment threadgithub/repos_rules.go Outdated
Comment threadgithub/repos_rules.go Outdated
Comment threadgithub/repos_rules.go Outdated

added period at the end of comments
1246f00

alexandear reviewed Oct 15, 2024
View reviewed changes

Comment threadgithub/repos_rules.go Outdated

alexandear reviewed Oct 15, 2024
View reviewed changes

Comment threadgithub/event_types.go

Merge branch 'master' into feature/add-repositoryrulesetevent
6d8869c

gmlewis requested changes Oct 15, 2024
View reviewed changes

Comment threadgithub/event_types_test.go

Update github/event_types_test.go
bde7ac7

gmlewis requested changes Oct 15, 2024
View reviewed changes

gmlewisand others added 10 commits October 15, 2024 16:12

Update github/repos_rules.go
880258c
Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update github/event_types_test.go
1804218

Update github/event_types_test.go
a01f3c9

Update github/event_types_test.go
a4f6e1e

Update github/event_types_test.go
b0dec1b

Update github/event_types_test.go
0cf42c2

Update github/event_types_test.go
65358d5

Update github/event_types_test.go
4155211

Update github/repos_rules.go
eee97b3

Update github/repos_rules.go
ee1dbb6

gmlewis removed the NeedsReview PR is awaiting a review before merging. label Oct 15, 2024

gmlewis reviewed Oct 15, 2024
View reviewed changes

Comment threadgithub/repos_rules.go Outdated

Update github/repos_rules.go
dfd4dfe

gmlewis reviewed Oct 15, 2024
View reviewed changes

Comment threadgithub/repos_rules.go Outdated

Update github/repos_rules.go
eb20803

Run latest go generate
08855c3

gmlewis requested changes Oct 16, 2024
View reviewed changes

Comment threadgithub/event_types_test.go Outdated
Comment threadgithub/event_types_test.go Outdated
Comment threadgithub/event_types_test.go Outdated
Comment threadgithub/event_types_test.go Outdated

gmlewis added 4 commits October 16, 2024 07:00

Update github/event_types_test.go
f062b5a

Update github/event_types_test.go
85130e2

Update github/event_types_test.go
dac8ce6

Update github/event_types_test.go
e125889

gmlewis approved these changes Oct 16, 2024
View reviewed changes

gmlewis merged commit b93ab91 into google:masterOct 16, 2024

gmlewis mentioned this pull request Nov 27, 2024
Bump version of go-github to v67.0.0 #3360
Merged

stevehipwell mentioned this pull request Jan 9, 2025
Repository ruleset event doesn't match schema #3429
Closed

jlaportebot added a commit to jlaportebot/go-github that referenced this pull request Jun 28, 2026
Add Webhook for Repository ruleset (google#3305)
f3059d2
Fixes: google#3295.

Uh oh!

Conversation

unamdev0 commented Oct 4, 2024

Uh oh!

unamdev0 commented Oct 4, 2024

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

codecovBot commented Oct 4, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

unamdev0 commented Oct 4, 2024

Uh oh!

unamdev0 commented Oct 14, 2024

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

unamdev0 commented Oct 14, 2024

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gmlewis commented Oct 14, 2024

Uh oh!

unamdev0 commented Oct 14, 2024

Uh oh!

gmlewis commented Oct 14, 2024

Uh oh!

gmlewis commented Oct 14, 2024

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

unamdev0 commented Oct 14, 2024

Uh oh!

gmlewis commented Oct 14, 2024

Uh oh!

gmlewis commented Oct 14, 2024

Uh oh!

unamdev0 commented Oct 15, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmlewis commented Oct 15, 2024

Uh oh!

Uh oh!

Uh oh!

gmlewis commented Oct 15, 2024

Uh oh!

unamdev0 commented Oct 16, 2024

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecovBot commented Oct 4, 2024•
edited
Loading