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.

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

Conversation

samccann
Copy link
Contributor

@samccann samccann commented May 2, 2024

Fixes #87

@samccann samccann requested a review from felixfontein May 2, 2024 17:44
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

There are two aspects that should be changed:

  1. This behavior should be configurable (via the config file), so collections (and ansible-core) can opt-in to this behavior;
  2. The test for when to add . needs to be improved so it doesn't add periods after other punctuation; this can be done with ... description.endswith((".", ",", "!", "?"));

Also this feature needs a changelog fragment :)

src/antsibull_changelog/plugins.py Outdated Show resolved Hide resolved
@samccann
Copy link
Contributor Author

Doing an interim push up cuz I need help. It fails CI nox tests with KeyError modules at:
https://github.com/ansible-community/antsibull-changelog/pull/162/files#diff-e5a31462878edf4ce7840f24144b38d1d878b0b6b0a0a182d8e49728e4e7aab7L429

Seems I've 'fixed it to death' and the changelog has no modules, but I'm not sure where my error is.

@samccann
Copy link
Contributor Author

samccann commented May 14, 2024

still on the todo list:

  • add specific test for this
  • add details to docs
  • changelog fragment ;-)

Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also mention the new config file entry in docs/changelog-configuration.md.

src/antsibull_changelog/cli.py Outdated Show resolved Hide resolved
docs/changelog-configuration.md Outdated Show resolved Hide resolved
tests/functional/test_changelog_basic_ansible.py Outdated Show resolved Hide resolved
docs/changelog-configuration.md Outdated Show resolved Hide resolved
changelogs/config.yaml Outdated Show resolved Hide resolved
samccann and others added 2 commits May 15, 2024 13:26
Co-authored-by: Felix Fontein <felix@fontein.de>
@felixfontein felixfontein merged commit a4f1b7c into ansible-community:main May 18, 2024
5 checks passed
@felixfontein
Copy link
Collaborator

@samccann thanks a lot for your contribution! :)

@samccann
Copy link
Contributor Author

Thanks for all the help! This was fun :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New module changelog entries should end with a .
2 participants