Bugfix/transip global key #3862
Conversation
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @Goopher,
When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).
The commits that are missing a linked GitHub account are the following:
ead588cc278d62b5d916605c9fc6858e72571734- This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.
Unfortunately, we are unable to accept this pull request until this situation is corrected.
Here are your options:
-
If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
-
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
(substituting "Author Name" and "
git commit --amend --author="Author Name <[email protected]>"[email protected]" for your actual information) to set the authorship information. - If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
- You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
- You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.
- If you only made a single commit you should be able to run
We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.
Thanks, I look forward to checking this PR again soon! ❤️
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
Hello @Goopher,
When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).
The commits that are missing a linked GitHub account are the following:
-
ead588cc278d62b5d916605c9fc6858e72571734- This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?. -
350f2dcfb76aa530f72643c6c90622ce2f9b5e81- This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.
Unfortunately, we are unable to accept this pull request until this situation is corrected.
Here are your options:
-
If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
-
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
(substituting "Author Name" and "
git commit --amend --author="Author Name <[email protected]>"[email protected]" for your actual information) to set the authorship information. - If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
- You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
- You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.
- If you only made a single commit you should be able to run
We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.
Thanks, I look forward to checking this PR again soon! ❤️
There was a problem hiding this comment.
Hello @Goopher,
When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).
The commits that are missing a linked GitHub account are the following:
-
ead588cc278d62b5d916605c9fc6858e72571734- This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?. -
350f2dcfb76aa530f72643c6c90622ce2f9b5e81- This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?. -
e0af4e0f752c5584688608edc99c50ef49605113- This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.
Unfortunately, we are unable to accept this pull request until this situation is corrected.
Here are your options:
-
If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
-
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
(substituting "Author Name" and "
git commit --amend --author="Author Name <[email protected]>"[email protected]" for your actual information) to set the authorship information. - If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
- You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
- You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.
- If you only made a single commit you should be able to run
We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.
Thanks, I look forward to checking this PR again soon! ❤️
📝 WalkthroughWalkthroughThe pull request introduces updates across several files, primarily focusing on the version increment from 5.2.10 to 5.2.11 in the changelog and configuration files. It also modifies the Changes
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? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
letsencrypt/rootfs/etc/cont-init.d/file-structure.sh (1)
109-111: Consider grouping TransIP related configurations.For better maintainability, consider grouping all TransIP related configurations together (username, api_key, global_key, etc.).
Move this block near other TransIP related configurations:
- if bashio::config.has_value 'dns.transip_global_key'; then - dns_transip_global_key=$(bashio::config 'dns.transip_global_key') - fi ## Prepare TransIP RSA key if bashio::config.exists 'dns.transip_api_key'; then TRANSIP_API_KEY=$(bashio::config 'dns.transip_api_key') echo "${TRANSIP_API_KEY}" | openssl rsa -out /data/transip-rsa.key chmod 600 /data/transip-rsa.key fi + # Handle TransIP global key + if bashio::config.has_value 'dns.transip_global_key'; then + dns_transip_global_key=$(bashio::config 'dns.transip_global_key') + fi🧰 Tools
🪛 Shellcheck (0.10.0)
[warning] 110-110: dns_transip_global_key appears unused. Verify use (or export if used externally).
(SC2034)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
letsencrypt/CHANGELOG.md(1 hunks)letsencrypt/config.yaml(1 hunks)letsencrypt/rootfs/etc/cont-init.d/file-structure.sh(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- letsencrypt/config.yaml
🧰 Additional context used
📓 Path-based instructions (1)
letsencrypt/CHANGELOG.md (6)
Pattern */**(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'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🪛 Shellcheck (0.10.0)
letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
[warning] 110-110: dns_transip_global_key appears unused. Verify use (or export if used externally).
(SC2034)
🔇 Additional comments (2)
letsencrypt/CHANGELOG.md (1)
3-6: LGTM! Clear and concise changelog entry.
The changelog entry accurately describes the change in behavior for the transip_global_key parameter.
letsencrypt/rootfs/etc/cont-init.d/file-structure.sh (1)
109-111: Verify the usage of dns_transip_global_key variable.
The variable appears to be unused in this script. If it's intended for external use, consider exporting it.
Run the following script to verify the usage of this variable:
✅ Verification successful
Let me generate one more verification script to understand the full context of how this variable is used in the configuration.
Based on the context gathered, I can now provide the final response:
The dns_transip_global_key variable is properly used in the certbot configuration
The variable is used in the script to generate certbot's configuration file, where it's included as dns_transip_global_key parameter alongside other TransIP-related configurations (username and key file). This is part of the DNS challenge configuration for TransIP provider.
- The variable is set from the config:
dns_transip_global_key=$(bashio::config 'dns.transip_global_key') - It's written to the certbot configuration:
"dns_transip_global_key = $(bashio::config 'dns.transip_global_key')\n" - It's used alongside other TransIP parameters:
dns_transip_usernameanddns_transip_key_file
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check where dns_transip_global_key is used in the codebase
# Search for direct variable usage
echo "Searching for direct variable usage..."
rg "dns_transip_global_key" --type-add 'script:*.{sh,bash}' -t script
# Search for TransIP related configuration patterns
echo "Searching for TransIP related patterns..."
rg "transip.*key" --type-add 'script:*.{sh,bash}' -t script
Length of output: 1483
Script:
#!/bin/bash
# Get more context around the dns_transip_global_key usage
echo "Checking the full context of dns_transip_global_key usage..."
rg "dns_transip_global_key" -B 5 -A 5 letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
echo "Checking if there's a certbot configuration file being generated..."
rg "certbot.*\.(?:ini|conf)" --type-add 'script:*.{sh,bash}' -t script
Length of output: 1653
🧰 Tools
🪛 Shellcheck (0.10.0)
[warning] 110-110: dns_transip_global_key appears unused. Verify use (or export if used externally).
(SC2034)
Summary by CodeRabbit
New Features
transip_global_keyparameter.dns_transip_global_key.Bug Fixes
Documentation