-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Formally deprecate the DHCP Server add-on #3980
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
Conversation
The maintenance of the ISC DHCP Server has been ended in 2022 already. Alpine Linux dropped the package in Alpine 3.21. Hence the add-on is deprecated as well.
📝 WalkthroughWalkthroughThe update introduces version 1.5.0 for the DHCP server add-on. The changelog now documents this new version with a deprecation notice and an update to Alpine 3.20 as the base image. The README has been modified to inform users that maintenance for the ISC DHCP Server ended in 2022 and to recommend alternative DHCP solutions. Additionally, the configuration file has been updated to version 1.5.0 with a new field marking its stage as deprecated. Changes
Assessment against linked issues
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
dhcp_server/README.md (1)
3-7
: Refine deprecation notice punctuation.
A comma is recommended after Hence for improved readability. For example, change:> Linux dropped the package in Alpine 3.21. Hence the add-on is deprecated as
to
> Linux dropped the package in Alpine 3.21. Hence, the add-on is deprecated as
🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: A comma may be missing after the conjunctive/linking adverb ‘Hence’.
Context: ...nux dropped the package in Alpine 3.21. Hence the add-on is deprecated as > well. Con...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
dhcp_server/CHANGELOG.md (1)
3-10
: Changelog entry is clear.
The version 1.5.0 entry correctly communicates the deprecation notice. As a minor refinement, consider simplifying the phrase “has been ended in 2022 already” to “ended in 2022” for conciseness.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
dhcp_server/CHANGELOG.md
(1 hunks)dhcp_server/README.md
(1 hunks)dhcp_server/config.yaml
(2 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md)
: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
dhcp_server/config.yaml
dhcp_server/README.md
dhcp_server/CHANGELOG.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md)
: - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
dhcp_server/config.yaml
dhcp_server/README.md
dhcp_server/CHANGELOG.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md)
: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
dhcp_server/config.yaml
dhcp_server/README.md
dhcp_server/CHANGELOG.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md)
: - Use sentence-style capitalization also in headings.
dhcp_server/config.yaml
dhcp_server/README.md
dhcp_server/CHANGELOG.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md)
: do not comment on HTML used for icons
dhcp_server/config.yaml
dhcp_server/README.md
dhcp_server/CHANGELOG.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md)
: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
dhcp_server/config.yaml
dhcp_server/README.md
dhcp_server/CHANGELOG.md
🪛 LanguageTool
dhcp_server/README.md
[uncategorized] ~6-~6: A comma may be missing after the conjunctive/linking adverb ‘Hence’.
Context: ...nux dropped the package in Alpine 3.21. Hence the add-on is deprecated as > well. Con...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
🔇 Additional comments (1)
dhcp_server/config.yaml (1)
2-2
: Configuration update is correct.
The update to version 1.5.0 and the addition of stage: deprecated correctly reflect the deprecation process for this add-on, aligning with the overall PR objectives.Also applies to: 56-56
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @agners 👍
../Frenck
With #3980 with added deprecated as a prefix to the add-on name. However, this leads to sorting it first, which isn't ideal. Move the deprecation notice to the end. Also add it to all the currently deprecated add-ons.
The maintenance of the ISC DHCP Server has been ended in 2022 already. Alpine Linux dropped the package in Alpine 3.21. Hence the add-on is deprecated as well.
Fixes: #3951
Summary by CodeRabbit
Documentation
Chores