MonkeyCanCode commented on PR #2006: URL: https://github.com/apache/polaris/pull/2006#issuecomment-3051040298
> > realized that the Helm README.md is generated, but there's nothing that guarantees that the file is up to date. I think, it would be better to not track the generated README.md in Git or at least have a CI step that verifies that the README.md file is up to date (aka generate in CI and compare with the one in Git). > > +1. The only reason to have that generated README.md file committed in Git was to allow users to read the Helm docs when browsing the GitHub repo. A CI check to enforce that it's in sync with the template would be nice. Great. So everyone agreed we will just copy file (automate it as part of the CI). I will close this for now then raise two separate PRs for adding the one time doc then another PR for the automation. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
