chore: Add new lint rule to make sure exported names documented #3682
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new lint rule to ensure all exported functions, methods, and structs are documented with godoc comments. The change introduces the exported rule from the revive linter to enforce documentation standards and adds missing godoc comments to existing exported symbols across the codebase.
Key changes:
- Added the
exportedrevive lint rule with specific configuration options - Added godoc comments to previously undocumented exported types, functions, and methods
- Reformatted existing deprecation comments to follow proper godoc conventions
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .golangci.yml | Adds the new exported lint rule configuration with options to disable checks on constants, variables, and stuttering |
| tools/sliceofpointers/sliceofpointers.go | Adds godoc comments for exported type and methods |
| github/security_advisories.go | Adds godoc comment for SecurityAdvisoriesService |
| github/search.go | Adds godoc comment for TopicResult type |
| github/repos_tags.go | Reformats deprecation comments to proper godoc format |
| github/orgs_audit_log.go | Adds godoc comments for JSON marshaling methods |
| github/github.go | Adds godoc comments for Error.UnmarshalJSON method and RateLimitCategory type |
| github/git_trees.go | Adds godoc comment for TreeEntry.MarshalJSON method |
| github/git_commits.go | Adds godoc comments for MessageSignerFunc.Sign method and CreateCommitOptions type |
| github/dependency_graph.go | Adds godoc comment for DependencyGraphService |
| github/copilot.go | Adds godoc comment for CopilotSeatDetails.UnmarshalJSON method |
| github/apps.go | Adds godoc comment for InstallationTokenListRepoOptions type |
| github/actions_workflow_runs.go | Adds godoc comment for ReferencedWorkflow type |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
gmlewis
approved these changes
Aug 16, 2025
There was a problem hiding this comment.
Thank you, @zyfy29!
LGTM.
Awaiting second LGTM+Approval from any other contributor to this repo before merging.
@alexandear or @stevehipwell - might you have time for a code review? Thank you!
alexandear
reviewed
Aug 18, 2025
Comment on lines
25
to
26
| // ListTagProtection lists tag protection of the specified repository. | ||
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#get-all-repository-rulesets |
There was a problem hiding this comment.
Suggested change
| // ListTagProtection lists tag protection of the specified repository. | |
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#get-all-repository-rulesets | |
| // ListTagProtection lists tag protection of the specified repository. | |
| // | |
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#get-all-repository-rulesets | |
There must be an empty line before Deprecated: to be properly recognized with pkg.go.dev.
Without empty line:
With empty line:
Comment on lines
48
to
49
| // CreateTagProtection creates the tag protection of the specified repository. | ||
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#create-a-repository-ruleset |
There was a problem hiding this comment.
Suggested change
| // CreateTagProtection creates the tag protection of the specified repository. | |
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#create-a-repository-ruleset | |
| // CreateTagProtection creates the tag protection of the specified repository. | |
| // | |
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#create-a-repository-ruleset |
Comment on lines
71
to
72
| // DeleteTagProtection deletes a tag protection from the specified repository. | ||
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset |
There was a problem hiding this comment.
Suggested change
| // DeleteTagProtection deletes a tag protection from the specified repository. | |
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset | |
| // DeleteTagProtection deletes a tag protection from the specified repository. | |
| // | |
| // Deprecated: This operation is deprecated and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead: https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset |
There was a problem hiding this comment.
I'll fix it, thank you!
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3682 +/- ##
=======================================
Coverage 91.07% 91.07%
=======================================
Files 186 186
Lines 16563 16563
=======================================
Hits 15085 15085
Misses 1293 1293
Partials 185 185 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
alexandear
approved these changes
Aug 18, 2025
|
Thank you, @alexandear! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close #3666
added a new lint rule by revive to make sure exported functions, methods and structs documented by godoc, and added missing godoc comments for existing names