Docs/strict and lenient

[briantist]

SUMMARY

Builds on the changes in https://github.com/ansible-community/github-docs-build/pull/27 .

• Set the push build to the strictest set of option
• On PR, set the PR build to the most lenient set of options; this gives us the best possibility of a publishable build, because a partial build of the docsite is more useful than none at all
• On PR, add an additional docs build (no comparison to base) with the most strict settings; this serves as the quality/validator for the PR, so even if the lenient build for the PR publish passes, this one will catch other errors and "fail" the PR

As with all pull_request_target workflow changes, the tests run in this PR do not test the changes to the workflow.

Test PR is needed against this branch to test functionality.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

docs-build

ADDITIONAL INFORMATION

[briantist]

I forgot that these options are for initialization only, and this collection skips init, so we can't use these.

Will have to reconsider how/whether to do this alongside having the committed init'd build env.

The reason we commit the env in this collection is:

• the slightly customize the main RST file (not terribly important)
• to give contributors an easier way to build docs locally without having to init themselves

A possible way to address this may be to further modify build.sh to take parameters.

To do that, would require options in the docs build workflows and build action. This might be a good idea anyway, I'm thinking of just making it a generic "extra args" type of thing that gets passed directly to the build script.

[briantist]

Also needs: https://github.com/ansible-community/antsibull/pull/409

[codecov[bot]]

Codecov Report

Merging #235 (9ed2ba6) into main (8e9c89b) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #235   +/-   ##
=======================================
  Coverage   97.49%   97.49%           
=======================================
  Files          56       56           
  Lines        2518     2518           
  Branches      185      185           
=======================================
  Hits         2455     2455           
  Misses         49       49           
  Partials       14       14           

Flag	Coverage Δ
env_docker-default	97.49% <ø> (ø)
integration	80.55% <ø> (ø)
sanity	38.61% <ø> (ø)
target_ansible-doc	100.00% <ø> (ø)
target_auth_approle	89.47% <ø> (ø)
target_auth_aws_iam	50.00% <ø> (ø)
target_auth_cert	86.36% <ø> (ø)
target_auth_jwt	91.30% <ø> (ø)
target_auth_ldap	89.47% <ø> (ø)
target_auth_none	100.00% <ø> (ø)
target_auth_token	71.42% <ø> (ø)
target_auth_userpass	85.71% <ø> (ø)
target_connection_options	74.76% <ø> (ø)
target_controller	75.51% <ø> (ø)
target_filter_vault_login_token	77.77% <ø> (ø)
target_import	38.61% <ø> (ø)
target_lookup_hashi_vault	81.33% <ø> (ø)
target_lookup_vault_login	100.00% <ø> (ø)
target_lookup_vault_read	90.00% <ø> (ø)
target_lookup_vault_token_create	82.97% <ø> (ø)
target_lookup_vault_write	59.14% <ø> (ø)
target_module_utils	95.90% <ø> (ø)
target_module_vault_login	93.93% <ø> (ø)
target_module_vault_pki_generate_certificate	78.26% <ø> (ø)
target_module_vault_read	92.10% <ø> (ø)
target_module_vault_token_create	90.00% <ø> (ø)
target_module_vault_write	57.53% <ø> (ø)
target_modules	70.19% <ø> (ø)
units	93.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 8e9c89b...9ed2ba6. Read the comment docs.