errose28 commented on PR #6916: URL: https://github.com/apache/ozone/pull/6916#issuecomment-2256318464
Thanks for the input @devabhishekpal. Here's what I'm thinking based on the extra info you shared: 1. We have a GH action that runs as part of the CI on each commit merged to `master` only. 2. The action generates the markdown file for the site. 3. The action checks the [hash](https://docs.github.com/en/actions/learn-github-actions/expressions#hashfiles) of the markdown file against the hash of the one already committed. It only raises a PR if they differ. 4. The action raises a separate PR with the docs changes that we manually review and merge. - I don't think we make config key changes too often so the extra manual review should be ok. - For now it can raise a PR to the current docs (in the ozone repo) and the new docs (in the ozone-site repo) at the same time. Some thoughts: - In the dependabot changes, we added the commit onto the branch for the PR before it was merged. This was fine in that context because the PR was raised by a bot, but will be annoying to human developers because it will cause their local and upstream branches to diverge. - In step 2 above, either method of file generation would work: - A Java implementation would build the file as part of the Ozone build and it would be in the build artifact. It could pull the file out of the build artifact for that run and raise a PR. - A shell implementation could make the file from the source used in that run and raise a PR. - I'm not sure we need a separate artifact just for the generated file, because it will be raised in a PR in the same step which will serve as persistence. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
