Skip to content

Commit 8c9c46b

Browse files
committed
Release 2.18.0.
1 parent 69c0d8e commit 8c9c46b

9 files changed

Lines changed: 472 additions & 329 deletions

CHANGELOG.md

Lines changed: 228 additions & 186 deletions
Large diffs are not rendered by default.

CHANGELOG.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,43 @@ antsibull-docs -- Ansible Documentation Build Scripts Release Notes
44

55
.. contents:: Topics
66

7+
v2.18.0
8+
=======
9+
10+
Release Summary
11+
---------------
12+
13+
Feature and bugfix release.
14+
15+
Minor Changes
16+
-------------
17+
18+
- Add ``:anscollection:`` role to allow referencing collections. The syntax is ``:anscollection:`namespace.name```, or
19+
``:anscollection:`namespace.name#what``` for more specific parts of the index page
20+
(https://github.com/ansible-community/antsibull-docs/pull/393).
21+
- Extend ``:ansplugin:`` role to allow referencing role entrypoints. The syntax is ``:ansplugin:`namespace.name.role_name#entrypoint```
22+
(https://github.com/ansible-community/antsibull-docs/pull/393).
23+
- The ``lint-collection-docs`` subcommand has a new option ``--check-extra-docs-refs`` that checks references to collections in extra documentation files (``docs/docsite/rst``) (https://github.com/ansible-community/antsibull-docs/pull/392).
24+
- The ``lint-collection-docs``'s option ``--plugin-docs`` now also checks role entrypoints for existence (https://github.com/ansible-community/antsibull-docs/pull/392).
25+
26+
Deprecated Features
27+
-------------------
28+
29+
- The following default values for options to ``antsibull-docs lint-collection-docs`` are deprecated
30+
and will change in antsibull-docs 3.0.0:
31+
32+
* ``--plugin-docs`` will be enabled by default; right now the default is ``--no-plugin-docs``;
33+
* ``--skip-rstcheck`` will be enabled by default; right now the default is ``--no-skip-rstcheck`` (note that this applies to ``--plugin-docs``, not to checking extra documentation);
34+
* ``--check-extra-docs-refs`` will be enabled by default; right now the default is ``--no-check-extra-docs-refs``.
35+
36+
We suggested to already now explicitly state the default value if you do not want the extra checks to be run
37+
(https://github.com/ansible-community/antsibull-docs/pull/394).
38+
39+
Bugfixes
40+
--------
41+
42+
- Ansible-core 2.19 now lists standard Jinja2 tests and filters as members of ``ansible.builtin`` with minimal documentation, but without a ``name`` field in ``doc`` (https://github.com/ansible-community/antsibull-docs/pull/393).
43+
744
v2.17.1
845
=======
946

changelogs/changelog.yaml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1033,3 +1033,56 @@ releases:
10331033
- 2.17.1.yml
10341034
- 391-tempfile-fileutils.yml
10351035
release_date: '2025-06-17'
1036+
2.18.0:
1037+
changes:
1038+
bugfixes:
1039+
- Ansible-core 2.19 now lists standard Jinja2 tests and filters as members
1040+
of ``ansible.builtin`` with minimal documentation, but without a ``name``
1041+
field in ``doc`` (https://github.com/ansible-community/antsibull-docs/pull/393).
1042+
deprecated_features:
1043+
- 'The following default values for options to ``antsibull-docs lint-collection-docs``
1044+
are deprecated
1045+
1046+
and will change in antsibull-docs 3.0.0:
1047+
1048+
1049+
* ``--plugin-docs`` will be enabled by default; right now the default is
1050+
``--no-plugin-docs``;
1051+
1052+
* ``--skip-rstcheck`` will be enabled by default; right now the default
1053+
is ``--no-skip-rstcheck`` (note that this applies to ``--plugin-docs``,
1054+
not to checking extra documentation);
1055+
1056+
* ``--check-extra-docs-refs`` will be enabled by default; right now the
1057+
default is ``--no-check-extra-docs-refs``.
1058+
1059+
1060+
We suggested to already now explicitly state the default value if you do
1061+
not want the extra checks to be run
1062+
1063+
(https://github.com/ansible-community/antsibull-docs/pull/394).'
1064+
minor_changes:
1065+
- 'Add ``:anscollection:`` role to allow referencing collections. The syntax
1066+
is ``:anscollection:`namespace.name```, or
1067+
1068+
``:anscollection:`namespace.name#what``` for more specific parts of the
1069+
index page
1070+
1071+
(https://github.com/ansible-community/antsibull-docs/pull/393).'
1072+
- 'Extend ``:ansplugin:`` role to allow referencing role entrypoints. The
1073+
syntax is ``:ansplugin:`namespace.name.role_name#entrypoint```
1074+
1075+
(https://github.com/ansible-community/antsibull-docs/pull/393).'
1076+
- The ``lint-collection-docs`` subcommand has a new option ``--check-extra-docs-refs``
1077+
that checks references to collections in extra documentation files (``docs/docsite/rst``)
1078+
(https://github.com/ansible-community/antsibull-docs/pull/392).
1079+
- The ``lint-collection-docs``'s option ``--plugin-docs`` now also checks
1080+
role entrypoints for existence (https://github.com/ansible-community/antsibull-docs/pull/392).
1081+
release_summary: Feature and bugfix release.
1082+
fragments:
1083+
- 2.18.0.yml
1084+
- 392-improve-linting.yml
1085+
- 393-ansible-core-jinja-filters-tests.yml
1086+
- 394-refs.yml
1087+
- 395-deprecation.yml
1088+
release_date: '2025-06-24'

changelogs/fragments/2.18.0.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

changelogs/fragments/392-improve-linting.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/393-ansible-core-jinja-filters-tests.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/394-refs.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

changelogs/fragments/395-deprecation.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)