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

Collection documentation: do not wrongly interpret plugins/modules whose name starts with _ as deprecated #3715

Merged
merged 1 commit into from
May 15, 2023

Conversation

felixfontein
Copy link
Contributor

I'm not sure whether an issue exists for this I can reference. I spotted this while working on #3607 and noticing that a plugin in a collection I was uploading for testing was wrongly marked as deprecated.

In ansible-core itself, an underscore was interpreted this way also in ansible-doc and the validate-modules sanity test (but nowhere else), but that was changed for 2.15.

Ref: ansible/ansible#79362

@github-actions github-actions bot added backport-4.6 This PR should be backported to stable-4.6 (2.3) backport-4.7 This PR should be backported to stable-4.7 (2.4) labels May 14, 2023
@felixfontein felixfontein force-pushed the deprecated branch 2 times, most recently from 9aae340 to 07a9a75 Compare May 14, 2023 13:52
…ose name starts with `_` as deprecated.

No-Issue
Signed-off-by: Felix Fontein <felix@fontein.de>
@felixfontein
Copy link
Contributor Author

Not sure whether the changelog fragment's filename is OK like this; I took the PR's # since I'm not aware of a AH Jira issue.

@himdel himdel removed the backport-4.6 This PR should be backported to stable-4.6 (2.3) label May 14, 2023
@himdel
Copy link
Collaborator

himdel commented May 14, 2023

Good catch 👍

AAH 4.6 / AAP 2.3 is core 2.14, so we'll only want this in 4.7+, right?

@felixfontein
Copy link
Contributor Author

AAH 4.6 / AAP 2.3 is core 2.14, so we'll only want this in 4.7+, right?

They weren't really deprecated in ansible-core 2.14 either, it was just that valide-modules somehow assumed so and that ansible-doc showed them as deprecated and at the same time printed their name wrong (it removed the underscore).

Not backporting to 4.6 is probably saving some discussions so ... it's probably better :)

@himdel himdel merged commit e0387b9 into ansible:master May 15, 2023
@patchback
Copy link

patchback bot commented May 15, 2023

Backport to stable-4.7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-4.7/e0387b92a4581383abb8390e086d103bd3251af9/pr-3715

Backported as #3732

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request May 15, 2023
…ose name starts with `_` as deprecated. (#3715)

No-Issue
Signed-off-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit e0387b9)
himdel pushed a commit that referenced this pull request May 15, 2023
…ose name starts with `_` as deprecated. (#3715) (#3732)

No-Issue
Signed-off-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit e0387b9)

Co-authored-by: Felix Fontein <felix@fontein.de>
@github-actions github-actions bot added the backported-4.7 This PR has been backported to stable-4.7 (2.4) label May 15, 2023
@felixfontein felixfontein deleted the deprecated branch May 15, 2023 17:39
@felixfontein
Copy link
Contributor Author

@himdel thanks for reviewing and merging!

@himdel
Copy link
Collaborator

himdel commented May 16, 2023

Any time :)

@himdel himdel mentioned this pull request Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-4.7 This PR should be backported to stable-4.7 (2.4) backported-4.7 This PR has been backported to stable-4.7 (2.4)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants