Skip to content

chore(cmd-modules): deprecate --mode init#5005

Merged
aciba90 merged 1 commit into
canonical:mainfrom
aciba90:deprecate-cli-modules-init
Mar 7, 2024
Merged

chore(cmd-modules): deprecate --mode init#5005
aciba90 merged 1 commit into
canonical:mainfrom
aciba90:deprecate-cli-modules-init

Conversation

@aciba90
Copy link
Copy Markdown
Contributor

@aciba90 aciba90 commented Mar 5, 2024

Proposed Commit Message

chore(cmd-modules): deprecate --mode init

This code path is not excuted by cloud-init at boot time and can
potentially mislead people.

Deprecate `cloud-init modules --mode init` and point to
`cloud-init init` as the recommended cmd.

Additional Context

Test Steps

cloud-init modules -m init
cloud-init modules -m init --help

Checklist

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

Copy link
Copy Markdown
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

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

nit: Think we should add something to the cli --help output as well? Also I think I recall this being documented somewhere, maybe on the cli docs page.

+1

@holmanb holmanb self-assigned this Mar 6, 2024
@aciba90 aciba90 force-pushed the deprecate-cli-modules-init branch 2 times, most recently from 9d6ebd3 to 81a922c Compare March 6, 2024 12:01
This code path is not excuted by cloud-init at boot time and can
potentially mislead people.

Deprecate `cloud-init modules --mode init` and point to
`cloud-init init` as the recommended cmd.
@aciba90 aciba90 force-pushed the deprecate-cli-modules-init branch from 81a922c to 8b956e7 Compare March 6, 2024 12:15
@aciba90
Copy link
Copy Markdown
Contributor Author

aciba90 commented Mar 6, 2024

nit: Think we should add something to the cli --help output as well? Also I think I recall this being documented somewhere, maybe on the cli docs page.

+1

Good point, I have included deprecation messages in the cmd --help and rtd, thanks!

@aciba90 aciba90 merged commit 0c80569 into canonical:main Mar 7, 2024
@aciba90 aciba90 deleted the deprecate-cli-modules-init branch March 7, 2024 08:04
catmsred pushed a commit to catmsred/cloud-init that referenced this pull request Mar 11, 2024
This code path is not excuted by cloud-init at boot time and can
potentially mislead people.

Deprecate `cloud-init modules --mode init` and point to
`cloud-init init` as the recommended cmd.
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.

2 participants