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

[chore] Add godoc target #5176

Closed
wants to merge 1 commit into from
Closed

Conversation

pellared
Copy link
Member

@pellared pellared commented Apr 8, 2024

I was considering adding pkgsite to internal/tools/go.mod. However, it has no tagged version so updating would be quite painful (no dependabot updates). Related issue: dependabot/dependabot-core#2028

Copy link

codecov bot commented Apr 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.8%. Comparing base (014c6fc) to head (651d93e).

Additional details and impacted files

Impacted file tree graph

@@          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           

see 1 file with indirect coverage changes


.PHONY: godoc
godoc:
go install golang.org/x/pkgsite/cmd/pkgsite@latest
Copy link
Contributor

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

Copy link
Member Author

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.

Copy link
Contributor

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.

Copy link
Member Author

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

Copy link
Contributor

@MrAlias MrAlias Apr 8, 2024

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.

Copy link
Member Author

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:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
godoc:
pkgsite:

@pellared pellared closed this Apr 8, 2024
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.

3 participants