Skip to content

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

Merged
merged 3 commits into from
Apr 14, 2025
Merged

Conversation

agners
Copy link
Member

@agners agners commented Apr 8, 2025

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

    • Added deprecation notices to user-facing documents to inform that this is the final update due to discontinued maintenance.
    • Included a cautionary advisory suggesting users consider alternative DHCP solutions.
  • Chores

    • Bumped the release version to 1.5.0.
    • Updated the underlying platform, with the configuration now marked as deprecated.

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.
Copy link
Contributor

coderabbitai bot commented Apr 8, 2025

📝 Walkthrough

Walkthrough

The 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

File(s) Change Summary
dhcp_server/CHANGELOG.md, dhcp_server/README.md Added deprecation notice. Changelog includes new version 1.5.0 section with base image update (Alpine 3.20). README now advises on deprecation.
dhcp_server/config.yaml Updated version from 1.4.0 to 1.5.0 and added a new field: stage: deprecated.

Assessment against linked issues

Objective Addressed Explanation
Switch to a different server that is still maintained (3951) The update does not implement a switch to an alternative server.
Inform users about the end of life for ISC DHCPD (3951)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7fdf40 and 350530f.

📒 Files selected for processing (1)
  • dhcp_server/config.yaml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • dhcp_server/config.yaml

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 4575e54 and 2eb2f50.

📒 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

@agners agners requested a review from frenck April 10, 2025 18:12
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @agners 👍

../Frenck

@frenck frenck merged commit abfb8fc into master Apr 14, 2025
11 checks passed
@frenck frenck deleted the deprecate-dhcp-server-add-on branch April 14, 2025 13:21
agners added a commit that referenced this pull request Apr 17, 2025
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.
jacobktm pushed a commit to HomeBot-Automation/addons that referenced this pull request Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ISC DHCPD is end of life
2 participants