ansible-documentation icon indicating copy to clipboard operation
ansible-documentation copied to clipboard

Documentation Checklist: ansible-core 2.17

Open samccann opened this issue 4 months ago • 2 comments

Documentation checklist to prepare for and deliver the ansible-core 2.17 release. See follow-on comment for the full checklist.

samccann avatar Apr 04 '24 15:04 samccann

Tasks include:

  • [x] Review ansible-core porting guide to ensure the 2.17 porting guide is added to the index and ensure it links to core 2.17 changelogs.

  • [x] include 2.17 in the ansible-core support matrix and ensure maintenance/eol releases listed accurately. Include links to changelogs.

  • [x] Verify or update the Powershell range for 2.17.

  • [x] Merge, then Backport any PRs for the above items to stable-2.17 branch.

  • [x] In stable-2.17 branch - Update ansible-core branch indicator file in docs/ansible-core-branch.txt in the stable-2.17 branch from devel to stable-2.17. See https://github.com/ansible/ansible-documentation/pull/424

  • [x] Publish 2.17 docs to test after 2.17 beta! 4/8/2024

  • [x] Update conf.py (DO NOT MERGE UNTIL RELEASE DAY)

    • [x] Set '2.17' if tags.has('core_lang') or tags.has('core') else, under 'html_context' 'latest_version'
    • [x] Set ('2.17', '2.16', '2.15', 'devel',) if tags.has('core') else, under ‘html_context’ 'available_versions'
    • [x] Verify Ansible package porting guide and roadmaps are listed under ‘exclude_patterns’. stable-2.17 branch:
  • [x] In stable-2.17 branch - change VERSION (capitalized) from devel to 2.17 as follows: '2.17' if tags.has('core_lang') or tags.has('core') else

On release day:

  • [x] Merge conf.py PR to devel
  • [x] Backport to stable-2.17, stable-2.16, and stable-2.15
  • [x] publish to all three releases to prod

Post release:

  • [x] Update the backport instructions to target the new “latest” branch, see https://github.com/ansible/ansible-documentation/pull/799
  • [x] Make sure all server-side redirects are updated as necessary - see https://github.com/ansible/docsite/pull/11
  • [ ] End-of-life the 2.14 docs
    • [x] update the release/maintenance table to add EOL label to 2.14 row.
    • [x] In the EOL branch (stable-2.14), update page banner to EOL to the release no longer supported. See https://github.com/ansible/ansible/pull/80957

samccann avatar Apr 04 '24 15:04 samccann

core-2.17 published to test - http://docs.testing.ansible.com/ansible-core/2.17/

NOTE: Version switcher etc will not work until release day.

samccann avatar Apr 05 '24 18:04 samccann