-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[chore] Add godoc target #5176
[chore] Add godoc target #5176
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5176 +/- ##
=====================================
Coverage 83.8% 83.8%
=====================================
Files 254 254
Lines 16532 16532
=====================================
+ Hits 13864 13866 +2
+ Misses 2375 2373 -2
Partials 293 293 |
|
||
.PHONY: godoc | ||
godoc: | ||
go install golang.org/x/pkgsite/cmd/pkgsite@latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be included in our tools instead of installed each invocation of godoc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See description why I decided this way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are commit releases. We should track those. Dependabot can handle updates for that as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dependabot can handle updates for that as well.
Are you sure? The related issue and my experience says otherwise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If not, I do not support adding this. It deviates from our tooling pattern and, as you pointed out, is not a stable set of tooling that we can guarantee versioning for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am totally fine with it. Closing the PR.
@@ -310,3 +310,8 @@ lint-markdown: | |||
.PHONY: verify-readmes | |||
verify-readmes: | |||
./verify_readmes.sh | |||
|
|||
.PHONY: godoc | |||
godoc: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
godoc: | |
pkgsite: |
I was considering adding
pkgsite
tointernal/tools/go.mod
. However, it has no tagged version so updating would be quite painful (no dependabot updates). Related issue: dependabot/dependabot-core#2028