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

redhat_subscription: officially deprecate "autosubscribe" #6646

Conversation

ptoscano
Copy link
Contributor

@ptoscano ptoscano commented Jun 9, 2023

SUMMARY

The autosubscribe alias for the auto_attach option has been deprecated for many years, although only in the documentation. Officially mark it as deprecated also in the module parameters spec, slating it for removal in 9.0.0.

The short deprecation time is because of the following reasons:

  • auto_attach was introduced many years ago, so even if you rely on e.g. Ansible 2.9, that option is there already
  • migrating from autosubscribe to auto_attach is very easy
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

redhat_subscription

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! Can you add a changelog fragment (with deprecated_features section) for this?

plugins/modules/redhat_subscription.py Outdated Show resolved Hide resolved
plugins/modules/redhat_subscription.py Outdated Show resolved Hide resolved
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-7 Automatically create a backport for the stable-7 branch labels Jun 9, 2023
@ansibullbot

This comment was marked as outdated.

@ansibullbot
Copy link
Collaborator

@ptoscano: Greetings! Thanks for taking the time to open this pullrequest. In order for the community to handle your pullrequest effectively, we need a bit more information.

Here are the items we could not find in your description:

  • issue type

Please set the description of this pullrequest with this template:
https://raw.githubusercontent.com/ansible/ansible/devel/.github/PULL_REQUEST_TEMPLATE.md

click here for bot help

@ansibullbot
Copy link
Collaborator

@ansibullbot ansibullbot added ci_verified Push fixes to PR branch to re-run CI module module needs_info This issue requires further information. Please answer any outstanding questions needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR needs_template This issue/PR has an incomplete description. Please fill in the proposed template correctly plugins plugin (any type) redhat_subscription labels Jun 9, 2023
@ptoscano
Copy link
Contributor Author

ptoscano commented Jun 9, 2023

Can you add a changelog fragment (with deprecated_features section) for this?

Sure; I always send the PR first, since the changelog fragment needs the PR number in its filename and in its text.

Also: I did not select any issue type, as I did not think any of all the existing ones would fit. Is it ok?

@ptoscano ptoscano force-pushed the redhat_subscription-deprecate-autosubscribe branch from c99b182 to 57b8fc1 Compare June 9, 2023 05:20
The "autosubscribe" alias for the "auto_attach" option has been
deprecated for many years, although only in the documentation.
Officially mark it as deprecated also in the module parameters spec,
slating it for removal in 9.0.0.
@ptoscano ptoscano force-pushed the redhat_subscription-deprecate-autosubscribe branch from 57b8fc1 to fd757fa Compare June 9, 2023 05:24
@ansibullbot ansibullbot added docs and removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR needs_info This issue requires further information. Please answer any outstanding questions needs_template This issue/PR has an incomplete description. Please fill in the proposed template correctly labels Jun 9, 2023
@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jun 9, 2023
@felixfontein felixfontein merged commit 621bedf into ansible-collections:main Jun 9, 2023
136 checks passed
@patchback
Copy link

patchback bot commented Jun 9, 2023

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/621bedf7517cbea7863959435eaf1c4032250b00/pr-6646

Backported as #6655

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

@felixfontein
Copy link
Collaborator

@ptoscano thanks!

patchback bot pushed a commit that referenced this pull request Jun 9, 2023
The "autosubscribe" alias for the "auto_attach" option has been
deprecated for many years, although only in the documentation.
Officially mark it as deprecated also in the module parameters spec,
slating it for removal in 9.0.0.

(cherry picked from commit 621bedf)
@ptoscano ptoscano deleted the redhat_subscription-deprecate-autosubscribe branch June 9, 2023 12:05
felixfontein pushed a commit that referenced this pull request Jun 9, 2023
…y deprecate "autosubscribe" (#6655)

redhat_subscription: officially deprecate "autosubscribe" (#6646)

The "autosubscribe" alias for the "auto_attach" option has been
deprecated for many years, although only in the documentation.
Officially mark it as deprecated also in the module parameters spec,
slating it for removal in 9.0.0.

(cherry picked from commit 621bedf)

Co-authored-by: Pino Toscano <ptoscano@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-7 Automatically create a backport for the stable-7 branch docs module module plugins plugin (any type) redhat_subscription
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants