Add Collection Docs workflow to generate docs artifacts #790
Conversation
ansibullbot
added
community_review
feature
|
Build succeeded.
|
|
CC @briantist |
|
Looks good to me. (Even though that's not what I was suggested, but this is also great :D ) I guess you have to merge this so that the action actually runs. It did however ran in @tremble's repo: https://github.com/tremble/amazon.aws/runs/6173432175?check_suite_focus=true The problem seems to be an undefined label |
|
The reason this doesn't work is probably I guess this reference should be avoided. Better link to the Tower product page or something like that :) |
tremble
changed the title
|
I'm switching this to a "WIP" as merging will currently break things due to the broken link in the docs. I don't intend to change this PR (the PR worked, the docs are broken), instead I'll have some separate PRs for fixing and updating the guides/docs |
I think this is the right move, in fact I might make it more strict by having it fail on errors. Since this PR is adding PR docs build, I would add another job that runs parallel to the build, like we've done on This runs a separate build (validate) with the most strict options (fail the CI on any problem), while the build that produces an artifact (and could be published) is produced with the most lenient options, giving the best chance of producing rendered docs you can look at, even if they have some errors. This PR doesn't seem to be adding a build on push, but that's a good one to have too. It would look like this (a little simpler), but you can remove the publishing step: |
|
The extra validate job is something I want to incorporate into the PR shared workflow so it will not need to be added manually: It's also fine to leave this PR as is, and get a validate job automatically when the shared workflow is updated. |
Various docs fixups SUMMARY Attempting to enable a docs linting workflow (#790) we picked up on a number of issues with the docs formating (mostly related to `foo` vs ``foo``) ISSUE TYPE Bugfix Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst docs/docsite/rst/guide_aws.rst ec2_group ec2_snapshot ec2_vpc_dhcp_option_info ADDITIONAL INFORMATION For a full list of issues: https://github.com/tremble/amazon.aws/runs/6174097260?check_suite_focus=true Reviewed-by: Felix Fontein <[email protected]> Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Jill R <None>
Various docs fixups SUMMARY Attempting to enable a docs linting workflow (#790) we picked up on a number of issues with the docs formating (mostly related to `foo` vs ``foo``) ISSUE TYPE Bugfix Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst docs/docsite/rst/guide_aws.rst ec2_group ec2_snapshot ec2_vpc_dhcp_option_info ADDITIONAL INFORMATION For a full list of issues: https://github.com/tremble/amazon.aws/runs/6174097260?check_suite_focus=true Reviewed-by: Felix Fontein <[email protected]> Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Jill R <None> (cherry picked from commit 3f46a94)
[PR #792/3f46a945 backport][stable-3] Various docs fixups This is a backport of PR #792 as merged into main (3f46a94). SUMMARY Attempting to enable a docs linting workflow (#790) we picked up on a number of issues with the docs formating (mostly related to `foo` vs ``foo``) ISSUE TYPE Bugfix Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst docs/docsite/rst/guide_aws.rst ec2_group ec2_snapshot ec2_vpc_dhcp_option_info ADDITIONAL INFORMATION For a full list of issues: https://github.com/tremble/amazon.aws/runs/6174097260?check_suite_focus=true Reviewed-by: Jill R <None>
|
Build succeeded.
|
|
@felixfontein @briantist - Any idea how to solve: It's caused by a module having 'S3_URL' as an alias for the 's3_url' parameter. This feels like it's actually a bug in antsibull-docs ? |
|
Build succeeded.
|
This one is addressed by: It looks like that will probably get merged/released in a relatively short amount of time, but if you want to work around it, use the |
tremble
changed the title
tremble
changed the title
tremble
changed the title
|
And with doc fixups (#796 #792) merged main is now in a good state. @jillr @alinabuzachis how do you feel about enabling this. From my testing, unless we backport this, the workflow won't trigger on the stable- branches. But I think this is actually ok since the testing should have happened in main prior to anything being backported. |
There was a problem hiding this comment.
From my testing, unless we backport this, the workflow won't trigger on the stable- branches. But I think this is actually ok since the testing should have happened in main prior to anything being backported.
I guess there's two ways to look at it: if you want to eventually publish separate documentation for the other stable branches (not on docs.ansible.com), it should be backported. My collection doesn't use stable branches but I do publish docs for the main branch for example, so that they are available somewhere.
I am working on a shared workflow for publishing to GitHub pages; there's already one to publish to surge.sh which is what I use on my collection currently.
You also don't have to wait for me and can implement your own publishing at any time.
Anyway all that can be revisited after working with it on main first I suppose :)
how do you feel about enabling this
Also I'll point out it's very easy to disable even temporarily, through the workflow's page in the Actions tab; a commit is not needed to disable/reenable. So it's very low stakes to try!
|
I second Brian, this is very easy to deactivate, so I would suggest to add this to |
|
Build succeeded (gate pipeline).
|
|
Pull request merge failed: Resource not accessible by integration |
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
) ec2_lc: add volume throughput parameter support SUMMARY Adding throughput parameter support to ec2_lc. Fixes ansible-collections#784. ISSUE TYPE Feature Pull Request COMPONENT NAME community.aws.ec2_lc UPDATE: Integration tests being added in a separate PR: ansible-collections#824 Reviewed-by: Alina Buzachis <None> Reviewed-by: Jill R <None>
) ec2_lc: add volume throughput parameter support SUMMARY Adding throughput parameter support to ec2_lc. Fixes ansible-collections#784. ISSUE TYPE Feature Pull Request COMPONENT NAME community.aws.ec2_lc UPDATE: Integration tests being added in a separate PR: ansible-collections#824 Reviewed-by: Alina Buzachis <None> Reviewed-by: Jill R <None>
) ec2_lc: add volume throughput parameter support SUMMARY Adding throughput parameter support to ec2_lc. Fixes ansible-collections#784. ISSUE TYPE Feature Pull Request COMPONENT NAME community.aws.ec2_lc UPDATE: Integration tests being added in a separate PR: ansible-collections#824 Reviewed-by: Alina Buzachis <None> Reviewed-by: Jill R <None>
SUMMARY
Generate diffs and artefacts when someone pushes a docs PR
ISSUE TYPE
COMPONENT NAME
.github/workflow
ADDITIONAL INFORMATION
Suggested by felixfontein on #787
Example run: https://github.com/tremble/amazon.aws/actions/runs/2238465237