Skip to content

enable formatting for the description field #353

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eherde
Copy link

@eherde eherde commented Jul 2, 2025

This isn't ready but I wanted to open an example of what I am thinking about to get feedback. Is this in the right direction? I've kept the scope to just the description field and not comments and to one resource just to keep the PR small.

@jstudler
Copy link
Collaborator

jstudler commented Jul 3, 2025

Thanks for opening this draft PR. As mentioned in #352 we think the customization of the description field is a nice addition.

A few suggestions and comments:

  • For the templating, we suggest to use go templates so we can leverage Golang's builtin features.
  • As you mentioned in the comment, the truncating needs to be handled differently
  • We could also consider moving warningComment from constant.go to the viper env vars so we can maximize the customization

Other than that it should be fairly straight forward and we're happy to review this PR.

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.

2 participants