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

Deprecating the old module vm_list_group_by_clusters #25

Merged
merged 2 commits into from
May 28, 2024
Merged

Deprecating the old module vm_list_group_by_clusters #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26253ea
Deprecating the old module vm_list_group_by_clusters
bardielle May 21, 2024
11dee29
Update changelogs/fragments/25-deprecated_module_vm_list_goup_by_clus…
bardielle May 28, 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
2 changes: 1 addition & 1 deletion CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ vmware.vmware Release Notes
v1.1.0
======

Major Changes
Minor Changes
-------------

- Added module vm_list_group_by_clusters
Expand Down
2 changes: 1 addition & 1 deletion changelogs/changelog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ releases:
release_date: '2024-05-07'
1.1.0:
changes:
major_changes:
minor_changes:
- Added module vm_list_group_by_clusters
Comment on lines -17 to 18
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure if it's acceptable to alter the changelog after the release. Not 100% sure, though.

cc @Andersson007

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure either but that's was my understanding from his comment in that discussion

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's OK, though there's another file https://github.com/ansible-collections/vmware.vmware/blob/main/CHANGELOG.rst where the changes should be reflected.
@felixfontein if we change the entries in both the files same way, will ansibull-changelog be OK with it?

Copy link
Collaborator Author

@bardielle bardielle May 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks I updated that file as well

Copy link
Contributor

Choose a reason for hiding this comment

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

CHANGELOG.rst is likely autogenerated, you can use antsibull-changelog generate to update it from changelogs/changelog.yaml.

It's best to not manually edit the output file since antsibull-changelog will overwrite it for the next release anyway. Better only change the YAML file (either directly or indirectly through antsibull-changelog release) and let antsibull-changelog update the output files.

(You can also enable MarkDown output for antsibull-changelog BTW.)

Copy link
Contributor

Choose a reason for hiding this comment

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

didn't know such a feature exists:), thanks!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks @felixfontein I reverted the manual change and ran antsibull-changelog generate and pushed it.

fragments:
- 16-vm_list_group_by_clusters.yml
Expand Down
2 changes: 2 additions & 0 deletions changelogs/fragments/25-deprecated_module_vm_list_goup_by_clusters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
deprecated_features:
- vm_list_group_by_clusters - deprecate the module since it was renamed to ``vm_list_group_by_clusters_info``
7 changes: 7 additions & 0 deletions meta/runtime.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
requires_ansible: '>=2.15.0'
plugin_routing:
modules:
vm_list_group_by_clusters:
redirect: vmware.vmware.vm_list_group_by_clusters_info
deprecation:
removal_version: 2.0.0
warning_text: Use M(vmware.vmware.vm_list_group_by_clusters_info) instead.
Loading