Use go templates on tag descriptions too

[same-id]

Using go templates is extremely useful for tag sections such as "Getting Started" etc, which it is a lot easier to just simply import a markdown file.

P.S.
I don't super like the fact that if the file is not found, it fails silently - I imagine cases where documentation will be missing in CI systems (internal repo paths will be exposed), and all for the sake of "debuggability" - might as well fail the process.
But I kept the current implementation for missing imports.

References to other Issues or PRs

Have you read the Contributing Guidelines?

Brief description of what is fixed or changed

Other comments

Summary by CodeRabbit

• New Feature: Enhanced the renderServiceTags and applyTemplate functions in template.go. These changes allow for dynamic modification of the Description field of tags based on certain conditions, improving flexibility and customization.
• Test: Added a new test function TestTagsWithGoTemplate in template_test.go. This function tests the generation of tags using Go templates, ensuring the accuracy and reliability of the new feature.

[coderabbitai]

Walkthrough

This update enhances the protoc-gen-openapiv2 package by refining the tag generation process in Go templates. It modifies the Description field of tags based on certain conditions and adds a new test function to verify these changes.

Changes

File	Summary
.../genopenapi/template.go	Updated renderServiceTags and applyTemplate functions to modify the Description field of tag and newTag structs based on the return value of reg.GetUseGoTemplate(). Also, updated ExternalDocs.Description field if it exists.
.../genopenapi/template_test.go	Added a new test function TestTagsWithGoTemplate that verifies the generation of tags using Go templates. The test checks if the generated tags match the expected tags in terms of name and description.

🐇💻

"In the land of code, where logic intertwines,
A rabbit hops along the lines.
With each leap, a change is made,
In the realm where bugs invade.

Tags are tweaked, tests are spun,
Ensuring all is neatly done.
Celebrate this update's birth,
For it brings joy to coders on Earth!" 🎉🥕

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Mention @coderabbitai in any review comment for bot assistance.
• Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

• Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

[coderabbitai]

Review Status

Actionable comments generated: 0

Commits

Files that changed from the base of the PR and between e36d15b and 0c4e2c6 commits.

Files selected for processing (2)

• protoc-gen-openapiv2/internal/genopenapi/template.go (2 hunks)
• protoc-gen-openapiv2/internal/genopenapi/template_test.go (1 hunks)

Files skipped from review due to trivial changes (1)

• protoc-gen-openapiv2/internal/genopenapi/template_test.go

Additional comments (Suppressed): 2

protoc-gen-openapiv2/internal/genopenapi/template.go (2)

• 1096-1112: The new implementation introduces the use of Go templates for tag descriptions. Ensure that all instances where tag.Description and tag.ExternalDocs.Description are used have been updated to handle the potential template syntax.

• 1998-2014: Similar to the previous comment, this hunk also introduces the use of Go templates for tag descriptions. Again, verify that all instances where newTag.Description and newTag.ExternalDocs.Description are used have been updated to handle the potential template syntax.

[same-id]

Timeout on golang CI

[same-id]

Timeout on golang CI

Not the first time this happens.

I think this is because golangci-lint runs only on pull requests (and not on main post merge) - so cache is not shared between different pull requests, so usually first push to PR will fail on timeout, second will succeed.

[johanbrandhorst]

Yeah it keeps happening, it really shouldn't be a matter of caching, it should take no time to run 🤔

[sam-utila]

Not sure about that, golangci-lint is one of the slowest linters I have ever used, it downloads dependencies as well. With cache it is super fast though.

[johanbrandhorst]

LGTM!

[johanbrandhorst]

Thanks for your contribution!