home-assistant / addons

:heavy_plus_sign: Docker add-ons for Home Assistant
https://home-assistant.io/hassio/
Apache License 2.0
1.57k stars 1.51k forks source link

Fix LetsEncrypt add-on - IONOS syntax error #3800

Closed dim-0 closed 1 month ago

dim-0 commented 1 month ago

Fixed Syntax Error in IONOS API execution

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes involve modifications to a Bash script that manages the Let's Encrypt certificate generation process. The primary adjustment is the addition of a missing quotation mark in the `PROVIDER_ARGUMENTS` array for the DNS provider "dns-ionos," ensuring correct interpretation of the credentials file path. The script maintains its existing logic for handling various DNS providers and includes sections for email notifications, domain management, and other functionalities essential for certificate issuance. ## Changes | File Path | Change Summary | |------------------------------------------------|-------------------------------------------------------------------------------| | letsencrypt/rootfs/etc/services.d/lets-encrypt/run | Corrected the construction of the `PROVIDER_ARGUMENTS` array for "dns-ionos" by adding a missing quotation mark to the credentials file path. | | letsencrypt/CHANGELOG.md | Updated changelog to include a new entry for version 5.2.3, documenting a fix for a syntax error in the run script. | | letsencrypt/config.yaml | Updated version number from `5.2.2` to `5.2.3`; no changes to other configuration fields. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Script participant DNSProvider User->>Script: Request certificate generation Script->>DNSProvider: Check provider credentials DNSProvider-->>Script: Return credentials status Script->>Script: Construct PROVIDER_ARGUMENTS Script->>DNSProvider: Execute certificate generation DNSProvider-->>Script: Return generation status Script-->>User: Notify completion ```

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 resolve` resolve all the CodeRabbit review comments. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
IDisposable commented 1 month ago

Can we get this merged, PLEASE? Entirely borked if we don't have a backup to rollback to...

ryanneufeld commented 1 month ago

This add-on is borked for new installs. That's what brought me here.

SolimanGit commented 1 month ago

This add-on is borked for new installs. That's what brought me here.

Same can't do anything

tasomaniac commented 1 month ago

Tagging @agners in case you wanna help merge this fix. Or apply the fix yourself.

dim-0 commented 1 month ago

Needs to be merged soon, as the bug that this PR fixes is currently breaking the whole add-on.

Yet again, I can only excuse for my dumbness and inattention when introducing this bug initially.

mislav commented 1 month ago

Thank you @dim-0 for a fast fix. I've looked into how a bash syntax error was undetected by this repository's shellcheck linter: https://github.com/home-assistant/addons/pull/3803

Turns out that most shell scripts in this repository were not subject to linting checks.

lbreggi commented 1 month ago

Hi! any idea when it is going to be updated?

agners commented 1 month ago

To make sure that the add-on gets updated in setups which use 5.2.2 already we need to bump the version again. I added just that.