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

Deprecating the old module vm_list_group_by_clusters #25

Merged
merged 2 commits into from
May 28, 2024

Conversation

bardielle
Copy link
Collaborator

SUMMARY

Deprecating the module vm_list_group_by_clusters since it will be replaced with vm_list_group_by_clusters_info in v2.0.0

ISSUE TYPE

Adding a deprecating

COMPONENT NAME

Deprecating the module vm_list_group_by_clusters since it will be replaced with vm_list_group_by_clusters_info in v2.0.0 and since then we will have 2 modules.
I used that doc in order to sign that module as deprecated

@bardielle bardielle force-pushed the change_vm_list_name branch from 423c860 to 9687734 Compare May 21, 2024 14:46
Comment on lines -17 to 18
major_changes:
minor_changes:
- Added module vm_list_group_by_clusters
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

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.

meta/runtime.yml Outdated Show resolved Hide resolved
@mariolenz
Copy link
Collaborator

Just wanted to work on this, also 😆

@bardielle
Copy link
Collaborator Author

@mariolenz thank you for your comments :)

@bardielle bardielle force-pushed the change_vm_list_name branch 3 times, most recently from 37d2a90 to 9128834 Compare May 22, 2024 12:16
@bardielle bardielle force-pushed the change_vm_list_name branch from 9128834 to 6d75d8c Compare May 27, 2024 10:38
@bardielle bardielle force-pushed the change_vm_list_name branch from 6d75d8c to 26253ea Compare May 27, 2024 10:40
@bardielle
Copy link
Collaborator Author

@mariolenz @felixfontein @Andersson007 Any disclaimers regarding that PR?

Copy link
Collaborator

@mariolenz mariolenz left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@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.

One last detail- changelog fragments are using ReStructured Text, so you need double backticks.

Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.58%. Comparing base (261e57a) to head (11dee29).
Report is 14 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main      #25       +/-   ##
===========================================
+ Coverage   13.71%   29.58%   +15.86%     
===========================================
  Files           7        8        +1     
  Lines        1917      605     -1312     
  Branches      478      112      -366     
===========================================
- Hits          263      179       -84     
+ Misses       1654      426     -1228     
Flag Coverage Δ
sanity 29.58% <ø> (+15.86%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bardielle
Copy link
Collaborator Author

thank you @felixfontein

@bardielle bardielle merged commit 15c150b into ansible-collections:main May 28, 2024
11 checks passed
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.

4 participants