-
Notifications
You must be signed in to change notification settings - Fork 524
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Output workflow parameters for approval details #1650
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of nits but this LGTM. Thanks @samccann
I gave this a go in my fork and can see the following in the log:
2024-06-26T09:11:59.6899198Z {
2024-06-26T09:11:59.6901004Z ansible-package-version: devel,
2024-06-26T09:11:59.6901742Z deploy: false,
2024-06-26T09:11:59.6902224Z deployment-environment: test,
2024-06-26T09:11:59.6902851Z language: english,
2024-06-26T09:11:59.6903390Z repository-branch: devel,
2024-06-26T09:11:59.6903939Z repository-name: ansible-documentation,
2024-06-26T09:11:59.6904672Z repository-owner: ansible
2024-06-26T09:11:59.6905137Z }
This info will definitely be useful when we need to review and approve deployments.
Co-authored-by: Don Naro <[email protected]>
@oraNod I think I fixed the extra whitespace problem. Can you take another look pls? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks @samccann
@samccann I feel like this is good to merge but no harm giving it a couple more days to give others a chance to review and comment. |
In that case, perhaps append it to |
This is a great suggestion and really makes an improvement. I found it was tricky to wrap the json in a code block without getting formatting issues. Since we can do markdown, I'd suggest adding a heading and pointing out only the details about the deployment that we really care about. What about something like this?
That could give us a summary page like this one: https://github.com/oraNod/ansible-documentation/actions/runs/9700881720/attempts/1#summary-26773300092 |
@oraNod @webknjaz thanks this helps a lot! I'm wondering if we can expand on don's example (which has each input appended to It would likely not look as pretty as Don's example, but it would have the benefit of not having to remember to update that step of the workflow if we change input parameters in the future. |
just to give a comparison - dumping the existing stuff to the job summary looks as follows and has the benefit of not having to ever update that part of the workflow: Using @oraNod's example of manually adding each input to the markdown job summary output looks (just a couple of inputs shown as an example): That one is definitely easier to read and we could probably get fancier with the markdown if we wanted to. So the question is do we go for:
We're about to drop the language input parameter, but historically, these inputs haven't changed much over time. |
You can include all the inputs in the summary, like I did here: oraNod@c0ec56d That results in a summary page such as: https://github.com/oraNod/ansible-documentation/actions/runs/9700669374#summary-26772605246 As I mentioned in my previous comment, I was wrangling with json formatting in that codeblock. I thought perhaps - for the purposes of the deployment approval - it might look nicer and more obvious if we highlighted only the inputs that were relevant, deployment environment and version. I suppose you could combine things. IMO I don't think we're likely to change the inputs . That one about the language doesn't really pertain to the deployment section anyway. It's kind of a deprecated input. There would be obvious errors if we, say, removed an input but didn't make the corresponding change in what we're logging to the summary. And the fix is easy. So I don't feel like there is a huge maintenance burden. You could add a comment to the input but that seems excessive. |
I guess my summary is that the intent of this PR is to make the details of the deployment destination readily apparent to approvers. It makes sense to have that scoped to only the relevant details for the person approving or rejecting the deployment job. |
Dumping json in a codeblock doesn't seem much better than just putting them in the log files. Adding more human readable plain text is a more elegant result. |
Thanks. I'll review the inputs later and update this pr with the prettier option so we can take a look again at it. |
(cherry picked from commit 7157eb4)
Co-authored-by: Don Naro <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @samccann
Remove latest symlink from publishing workflow (ansible#1615) * remove latest symlink Read The Docs allows you to configure which version corresponds to "latest" which means the symlink is no longer necessary. * add 11 to version list Co-authored-by: Sandra McCann <[email protected]> ci: refresh docs build dependencies (ansible#1635) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> fix Validate data against set criteria with Ansible doc (ansible#1636) fixed following example playbook fix Ansible architecture docs (ansible#1637) I fixed example Inventory ini format file contains '---' used in Yaml Integrate the `alls-green` action into the main GHA CI workflow (ansible#1639) * Integrating all-greens into ci.yml * removing non-existing references When rebuilding this work after repo cleanup, I missed removing these. Thanks for catching that. Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> * Update .github/workflows/ci.yaml --------- Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> Co-authored-by: Don Naro <[email protected]> Remove reference of scp_if_ssh option (ansible#1346) * Remove reference of scp_if_ssh option * scp_if_ssh is removed in Ansible 2.17, remove the references Fixes: ansible#1341 Signed-off-by: Abhijeet Kasurde <[email protected]> * review changes Co-authored-by: Maxwell G <[email protected]> * details about the smart setting --------- Signed-off-by: Abhijeet Kasurde <[email protected]> Co-authored-by: Maxwell G <[email protected]> Co-authored-by: Don Naro <[email protected]> Remove references to archived ansible/ansible-examples repository (ansible#1653) docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: avoid using aliases (ansible#1539) * docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases * Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst Co-authored-by: flowerysong <[email protected]> --------- Co-authored-by: Sandra McCann <[email protected]> Co-authored-by: flowerysong <[email protected]> [WIP, needs vote before merging] collection_requirements.rst: update (ansible#1422) * collection_requirements.rst: update * general updates * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Brian Scholer <[email protected]> * releasing policy MUST -> SHOULD * Remove setting upper bound warning * fix formatting * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Remove the Requirements for collections to be included in the Ansible Package section * Update galaxy section * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Remove extra line * Update Documentation requirements section * CoC feedback incorporate * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein <[email protected]> * Fix unnoticed conflict * Reformulate changelog section * Restructure Contributor Workflow section * Fix typo * Add sentence back * Restructure section * Handle Naming section * Handle Licensing section * Restructure Licensing section * Fix typo * Update repo management section * Update branch name and protection section * Undate CI testing section * Update When moving modules between collections section * Update Development conventions section * Update Collection dependencies section * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Restructure backwards compatibility section * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Fix formatting| * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Brian Scholer <[email protected]> Co-authored-by: Sandra McCann <[email protected]> Co-authored-by: Don Naro <[email protected]> Co-authored-by: Felix Fontein <[email protected]> Co-authored-by: Alicia Cozine <[email protected]> communication guide: overhaul (ansible#1667) communication guide: overhaul * Forum as default * Reorder so important information is at the top * remove old information --------- Co-authored-by: Don Naro <[email protected]> Co-authored-by: John Barker <[email protected]> Co-authored-by: Sandra McCann <[email protected]> ci: refresh dev dependencies (ansible#1657) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> ci: refresh docs build dependencies (ansible#1658) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Output workflow parameters for approval details (ansible#1650) * Output workflow parameters for approval details --------- Co-authored-by: Don Naro <[email protected]> ci: refresh dev dependencies (ansible#1675) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> ci: refresh docs build dependencies (ansible#1676) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Nightly builds for package docs publishing workflow (ansible#1663) Adding daily schedule to CI build (ansible#1659) * Adding daily schedule to CI build * Change from 0 minute to 23, per discussion and referenced suggestion. remove the schedule from the workflow dispatch job (ansible#1683) Relates to issue ansible#1682. This change removes the schedule to stop the workflow from failing due to null input values. We can either add this back with some expressions to set defaults for scheduled runs or create a simplified build workflow that runs on a schedule. notify docs matrix channel on docs build failures (ansible#1651) * notify docs matrix channel on docs build failures * add url with run id Remove language option from workflow (ansible#1681) * Remove deprecated language input from the publishing workflow collection_requirements: fix typo (ansible#1684) * collection_requirements: fix typo * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Don Naro <[email protected]> WIP restore anchor in communication guide (ansible#1692) Add porting guide for Ansible 10.2.0. (ansible#1697) Add porting guide for Ansible 9.8.0. (ansible#1698) Move community_topics_workflow to docs.ansible.com (ansible#1028) * Move community_topics_workflow to docs.ansible.com * Simplify * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Mario Lenz <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Mario Lenz <[email protected]> * Improve * Replacing Creating a topic section content * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Clarify * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Mario Lenz <[email protected]> Co-authored-by: Don Naro <[email protected]> ci: refresh docs build dependencies (ansible#1691) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Issue ansible#1633 nox session for tagging (ansible#1649) * WIP tagger session for nox * First pass tagging nox session * Formatting fixup * Adding removal of tmpdir as per discussion * tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one. * isort fixup * Working out suggested changes. * Linting cleanup on changes * Different approach to noted chagnes * Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone * Staging deletion per discussion * Adding tag session to dependency update job * after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts. * Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that. * I think this is where the call needed added to get the tags dependencies automatically updated * remove gitpython, add tag.txt, add blank line * Comment cleanup per OraNod * doc README: document nox tag session instead of manual mode * Update tests/typing.in Per suggestion from @webnjaz Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> --------- Co-authored-by: Maxwell G <[email protected]> Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> ci: refresh dev dependencies (ansible#1707) * ci: refresh dev dependencies * ci: refresh dev dependencies --------- Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Be more explicit about registering with a loop (ansible#1709) add vault password file example (ansible#1696) * add vault password file example * remove duplicate word in vault password file example Co-authored-by: Sandra McCann <[email protected]> --------- Co-authored-by: Sandra McCann <[email protected]> ci: refresh dev dependencies (ansible#1722) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> setting in-line defaults for running on a schedule
* WIP * setting in-line defaults for running on a schedule * ci: refresh dev dependencies (#1634) Remove latest symlink from publishing workflow (#1615) * remove latest symlink Read The Docs allows you to configure which version corresponds to "latest" which means the symlink is no longer necessary. * add 11 to version list Co-authored-by: Sandra McCann <[email protected]> ci: refresh docs build dependencies (#1635) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> fix Validate data against set criteria with Ansible doc (#1636) fixed following example playbook fix Ansible architecture docs (#1637) I fixed example Inventory ini format file contains '---' used in Yaml Integrate the `alls-green` action into the main GHA CI workflow (#1639) * Integrating all-greens into ci.yml * removing non-existing references When rebuilding this work after repo cleanup, I missed removing these. Thanks for catching that. Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> * Update .github/workflows/ci.yaml --------- Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> Co-authored-by: Don Naro <[email protected]> Remove reference of scp_if_ssh option (#1346) * Remove reference of scp_if_ssh option * scp_if_ssh is removed in Ansible 2.17, remove the references Fixes: #1341 Signed-off-by: Abhijeet Kasurde <[email protected]> * review changes Co-authored-by: Maxwell G <[email protected]> * details about the smart setting --------- Signed-off-by: Abhijeet Kasurde <[email protected]> Co-authored-by: Maxwell G <[email protected]> Co-authored-by: Don Naro <[email protected]> Remove references to archived ansible/ansible-examples repository (#1653) docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: avoid using aliases (#1539) * docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases * Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst Co-authored-by: flowerysong <[email protected]> --------- Co-authored-by: Sandra McCann <[email protected]> Co-authored-by: flowerysong <[email protected]> [WIP, needs vote before merging] collection_requirements.rst: update (#1422) * collection_requirements.rst: update * general updates * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Brian Scholer <[email protected]> * releasing policy MUST -> SHOULD * Remove setting upper bound warning * fix formatting * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Remove the Requirements for collections to be included in the Ansible Package section * Update galaxy section * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Remove extra line * Update Documentation requirements section * CoC feedback incorporate * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein <[email protected]> * Fix unnoticed conflict * Reformulate changelog section * Restructure Contributor Workflow section * Fix typo * Add sentence back * Restructure section * Handle Naming section * Handle Licensing section * Restructure Licensing section * Fix typo * Update repo management section * Update branch name and protection section * Undate CI testing section * Update When moving modules between collections section * Update Development conventions section * Update Collection dependencies section * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Restructure backwards compatibility section * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <[email protected]> * Fix formatting| * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein <[email protected]> * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Brian Scholer <[email protected]> Co-authored-by: Sandra McCann <[email protected]> Co-authored-by: Don Naro <[email protected]> Co-authored-by: Felix Fontein <[email protected]> Co-authored-by: Alicia Cozine <[email protected]> communication guide: overhaul (#1667) communication guide: overhaul * Forum as default * Reorder so important information is at the top * remove old information --------- Co-authored-by: Don Naro <[email protected]> Co-authored-by: John Barker <[email protected]> Co-authored-by: Sandra McCann <[email protected]> ci: refresh dev dependencies (#1657) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> ci: refresh docs build dependencies (#1658) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Output workflow parameters for approval details (#1650) * Output workflow parameters for approval details --------- Co-authored-by: Don Naro <[email protected]> ci: refresh dev dependencies (#1675) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> ci: refresh docs build dependencies (#1676) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Nightly builds for package docs publishing workflow (#1663) Adding daily schedule to CI build (#1659) * Adding daily schedule to CI build * Change from 0 minute to 23, per discussion and referenced suggestion. remove the schedule from the workflow dispatch job (#1683) Relates to issue #1682. This change removes the schedule to stop the workflow from failing due to null input values. We can either add this back with some expressions to set defaults for scheduled runs or create a simplified build workflow that runs on a schedule. notify docs matrix channel on docs build failures (#1651) * notify docs matrix channel on docs build failures * add url with run id Remove language option from workflow (#1681) * Remove deprecated language input from the publishing workflow collection_requirements: fix typo (#1684) * collection_requirements: fix typo * Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Don Naro <[email protected]> WIP restore anchor in communication guide (#1692) Add porting guide for Ansible 10.2.0. (#1697) Add porting guide for Ansible 9.8.0. (#1698) Move community_topics_workflow to docs.ansible.com (#1028) * Move community_topics_workflow to docs.ansible.com * Simplify * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Mario Lenz <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Mario Lenz <[email protected]> * Improve * Replacing Creating a topic section content * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> * Clarify * Update docs/docsite/rst/community/steering/community_topics_workflow.rst Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Mario Lenz <[email protected]> Co-authored-by: Don Naro <[email protected]> ci: refresh docs build dependencies (#1691) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Issue #1633 nox session for tagging (#1649) * WIP tagger session for nox * First pass tagging nox session * Formatting fixup * Adding removal of tmpdir as per discussion * tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one. * isort fixup * Working out suggested changes. * Linting cleanup on changes * Different approach to noted chagnes * Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone * Staging deletion per discussion * Adding tag session to dependency update job * after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts. * Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that. * I think this is where the call needed added to get the tags dependencies automatically updated * remove gitpython, add tag.txt, add blank line * Comment cleanup per OraNod * doc README: document nox tag session instead of manual mode * Update tests/typing.in Per suggestion from @webnjaz Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> --------- Co-authored-by: Maxwell G <[email protected]> Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> ci: refresh dev dependencies (#1707) * ci: refresh dev dependencies * ci: refresh dev dependencies --------- Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Be more explicit about registering with a loop (#1709) add vault password file example (#1696) * add vault password file example * remove duplicate word in vault password file example Co-authored-by: Sandra McCann <[email protected]> --------- Co-authored-by: Sandra McCann <[email protected]> ci: refresh dev dependencies (#1722) Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> setting in-line defaults for running on a schedule * Implementing comments --------- Co-authored-by: ansible-documentation-bot[bot] <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
Display the input parameters for the Ansible package docs build workflow so approvers can verify the correct settings before approving a deploy of the docs to prod or test.