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

Extend deprecation/removal note that collections can be installed manually after removal #371

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Extend deprecation/removal note that collections can be installed manually after removal #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions changelogs/fragments/371-removal-hint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- "Extend deprecation/removal note that collections can be installed manually after removal (https://github.com/ansible-community/antsibull-docs/pull/371)."
6 changes: 6 additions & 0 deletions src/antsibull_docs/cli/doc_commands/_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,12 @@ def _collect_removal_sentences(
if reason_text:
sentences.append(reason_text)

if reason not in ("renamed", "deprecated"):
sentences.append(
"Once removed, you can still install the collection manually"
f" with C(ansible-galaxy collection install {collection})."
)

if sentences and discussion:
sentences.append(
f"See the L(discussion thread, {discussion}) for more information."
Expand Down
Loading