Update documentation workflow, add CHANGELOG, and update pre-commit checks #171
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
… checks Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
jimright
requested changes
Jun 26, 2025
There was a problem hiding this comment.
All looks good with this PR and the docs build successfully for me and include the changelog.
Only suggestion is to update the building-the-api-documentation in top-level readme to point to the relevant hatch commands.
jimright
requested changes
Jun 26, 2025
There was a problem hiding this comment.
Also I've got an error on rendering the cloudera.cloud.env and cloudera.cloud.datalake pages:
ERROR:antsibull:func=create_plugin_rst:mod=antsibull_docs.write_docs.plugins:nonfatal_errors=['1 validation error for ModuleDocSchema\ndoc -> options -> upgrade -> choice\n extra fields not permitted (type=value_error.extra)']:plugin_name=cloudera.cloud.datalake:plugin_type=module|cloudera.cloud.datalake did not return correct DOCUMENTATION. An error page will be generated.
ERROR:antsibull:func=create_plugin_rst:mod=antsibull_docs.write_docs.plugins:nonfatal_errors=['1 validation error for ModuleDocSchema\ndoc -> options -> freeipa -> suboptions -> upgrade -> choice\n extra fields not permitted (type=value_error.extra)']:plugin_name=cloudera.cloud.env:plugin_type=module|cloudera.cloud.env did not return correct DOCUMENTATION. An error page will be generated.
building file list ... done
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
Signed-off-by: Webster Mudge <[email protected]>
github-actions
bot
removed
the
validated
I've fixed this in the PR |
github-actions
bot
added
validated
Updated the README with some instructions. |
Signed-off-by: Webster Mudge <[email protected]>
wmudge
force-pushed
the
feature/docsbuild-changelog
branch
from
fd4ac10 to
c0f78ff
Compare
github-actions
bot
removed
the
validated
Signed-off-by: Webster Mudge <[email protected]>
github-actions
bot
added
validated
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This includes
ansible-lintchecks