Skip to content
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.

Sign up for GitHub

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

Add period to end of new plugin statements in changelog #162

Merged
merged 16 commits into from
May 18, 2024
Merged

Add period to end of new plugin statements in changelog #162

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a0447e4
add period to short description changelog entry
samccann Apr 23, 2024
42b1775
partial fix - basic test
samccann Apr 23, 2024
ab55258
fix case where there is already a period
samccann Apr 24, 2024
95b23b5
update basic tests to add period
samccann Apr 25, 2024
1a0bb13
update two more test files
samccann Apr 30, 2024
5955da8
updated one more test
samccann May 1, 2024
4b33849
updated final CI test. All nox passing now
samccann May 2, 2024
63b547f
Update src/antsibull_changelog/plugins.py
samccann May 7, 2024
bde13d2
based on feedback - extend the tests of when to add a period
samccann May 7, 2024
bef8691
include add_plugin_period as config option
samccann May 9, 2024
002cf6d
add structure for config param
samccann May 13, 2024
73f93c2
remove my mistaken debug effort
samccann May 14, 2024
a54fa06
implement feedback. Passes local nox tests
samccann May 15, 2024
28dd0bb
Add changelog fragment and documentation
samccann May 15, 2024
3342d6a
Apply suggestions from code review
samccann May 15, 2024
1c1038d
fix CI errors for test
samccann May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/antsibull_changelog/plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,19 @@ def from_dict(

for plugin_type, plugin_data in data.items():
for plugin_name, plugin_details in plugin_data.items():
if plugin_details["description"]:
if plugin_details["description"].endswith("."):
description = plugin_details["description"]
else:
description = plugin_details["description"] + "."
else:
description = plugin_details["description"]
samccann marked this conversation as resolved.
Show resolved Hide resolved
plugins.append(
PluginDescription(
plugin_type=plugin_type,
name=plugin_name,
namespace=plugin_details.get("namespace"),
description=plugin_details["description"],
description=description,
version_added=plugin_details["version_added"],
category=category,
)
Expand Down
38 changes: 19 additions & 19 deletions tests/functional/test_changelog_basic_ansible.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,15 +264,15 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
assert changelog["releases"]["2.10"]["modules"] == [
{
"name": "test",
"description": "This is a test module",
"description": "This is a test module.",
"namespace": "",
},
]
assert changelog["releases"]["2.10"]["plugins"] == {
"lookup": [
{
"name": "bar",
"description": "A foo bar lookup",
"description": "A foo bar lookup.",
"namespace": None,
},
],
Expand Down Expand Up @@ -308,12 +308,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo bar lookup
- bar - A foo bar lookup.

New Modules
-----------

- test - This is a test module
- test - This is a test module.
"""
)

Expand Down Expand Up @@ -399,15 +399,15 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
assert changelog["releases"]["2.10"]["modules"] == [
{
"name": "test",
"description": "This is a TEST module",
"description": "This is a TEST module.",
"namespace": "",
},
]
assert changelog["releases"]["2.10"]["plugins"] == {
"lookup": [
{
"name": "bar",
"description": "A foo_bar lookup",
"description": "A foo_bar lookup.",
"namespace": None,
},
],
Expand Down Expand Up @@ -441,12 +441,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo_bar lookup
- bar - A foo_bar lookup.

New Modules
-----------

- test - This is a TEST module
- test - This is a TEST module.
"""
)

Expand Down Expand Up @@ -539,7 +539,7 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
assert changelog["releases"]["2.10.1b1"]["modules"] == [
{
"name": "test_new",
"description": "This is ANOTHER test module",
"description": "This is ANOTHER test module.",
"namespace": "",
},
]
Expand Down Expand Up @@ -569,7 +569,7 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
New Modules
-----------

- test_new - This is ANOTHER test module
- test_new - This is ANOTHER test module.

v2.10
=====
Expand All @@ -592,12 +592,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo_bar lookup
- bar - A foo_bar lookup.

New Modules
-----------

- test - This is a TEST module
- test - This is a TEST module.
"""
)

Expand Down Expand Up @@ -706,7 +706,7 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
assert changelog["releases"]["2.10.1"]["modules"] == [
{
"name": "test_new2",
"description": "This is ANOTHER test module!!!11",
"description": "This is ANOTHER test module!!!11.",
"namespace": "",
},
{
Expand Down Expand Up @@ -747,8 +747,8 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
New Modules
-----------

- test_new - This is ANOTHER test module
- test_new2 - This is ANOTHER test module!!!11
- test_new - This is ANOTHER test module.
- test_new2 - This is ANOTHER test module!!!11.
- test_new3 - This is yet another test module.

v2.10
Expand All @@ -772,12 +772,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo_bar lookup
- bar - A foo_bar lookup.

New Modules
-----------

- test - This is a TEST module
- test - This is a TEST module.
"""
)

Expand Down Expand Up @@ -1113,7 +1113,7 @@ def test_changelog_release_ansible_plugin_cache( # pylint: disable=redefined-ou
assert changelog["releases"]["2.10"]["modules"][0]["namespace"] == ""
assert (
changelog["releases"]["2.10"]["modules"][0]["description"]
== "A test module"
== "A test module."
)
assert "version_added" not in changelog["releases"]["2.10"]["modules"][0]

Expand All @@ -1135,7 +1135,7 @@ def test_changelog_release_ansible_plugin_cache( # pylint: disable=redefined-ou
New Modules
-----------

- test_module - A test module
- test_module - A test module.
"""
)

Expand Down
24 changes: 12 additions & 12 deletions tests/functional/test_changelog_basic_ansible_classic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,12 +291,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo bar lookup
- bar - A foo bar lookup.

New Modules
-----------

- test - This is a test module
- test - This is a test module.
"""
)

Expand Down Expand Up @@ -405,12 +405,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo_bar lookup
- bar - A foo_bar lookup.

New Modules
-----------

- test - This is a TEST module
- test - This is a TEST module.
"""
)

Expand Down Expand Up @@ -521,7 +521,7 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
New Modules
-----------

- test_new - This is ANOTHER test module
- test_new - This is ANOTHER test module.

v2.9
====
Expand All @@ -544,12 +544,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo_bar lookup
- bar - A foo_bar lookup.

New Modules
-----------

- test - This is a TEST module
- test - This is a TEST module.
"""
)

Expand Down Expand Up @@ -683,8 +683,8 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
New Modules
-----------

- test_new - This is ANOTHER test module
- test_new2 - This is ANOTHER test module!!!11
- test_new - This is ANOTHER test module.
- test_new2 - This is ANOTHER test module!!!11.
- test_new3 - This is yet another test module.

v2.9
Expand All @@ -708,12 +708,12 @@ def test_changelog_release_ansible_simple( # pylint: disable=redefined-outer-na
Lookup
~~~~~~

- bar - A foo_bar lookup
- bar - A foo_bar lookup.

New Modules
-----------

- test - This is a TEST module
- test - This is a TEST module.
"""
)

Expand Down Expand Up @@ -1042,7 +1042,7 @@ def test_changelog_release_ansible_plugin_cache( # pylint: disable=redefined-ou
New Modules
-----------

- test_module - A test module
- test_module - A test module.
"""
)

Expand Down
Loading