Tests: Filter response files for files ending with yaml #2356
Conversation
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @zyberzero,
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:
3dbf55d5f803ce1f7e4d3a5ce7bd72e1babf152b- 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 👍 |
WalkthroughWalkthroughThis update enhances the robustness of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant LanguageResponses
participant FileSystem
User->>LanguageResponses: Request language responses
LanguageResponses->>FileSystem: Retrieve files in directory
FileSystem-->>LanguageResponses: Return list of files
LanguageResponses->>LanguageResponses: Filter files for .yaml extension
LanguageResponses->>FileSystem: Load .yaml files
FileSystem-->>LanguageResponses: Return loaded responses
LanguageResponses-->>User: Return processed responses
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Files skipped from review as they are similar to previous changes (1)
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
zyberzero
force-pushed
the
filter-responses-for-yaml
branch
from
3dbf55d
to
5915fba
Compare
zyberzero
force-pushed
the
filter-responses-for-yaml
branch
from
5915fba
to
3580308
Compare
|
What editor do you use? I don't want to start adding workarounds for every editor under the sun. Aren't swap files short lived, and are the odds of this happening tiny? |
| @@ -73,5 +73,6 @@ def language_responses(language: str) -> dict[str, Any]: | |||
| """Load intent responses for a language.""" | |||
| merged_responses: dict = {} | |||
| for response_file in (RESPONSES_DIR / language).iterdir(): | |||
There was a problem hiding this comment.
Instead of iterdir, let's use glob
When creating some translations I noticed that when I, in my editor of choice, had opened a response file the tests failed.
It turned out that due to my editor created a
.swpfile in the response folder the tests failed as the yaml parser doesn't (correctly) interpret the swap file as valid UTF-8 and throws an exception, for example this:This PR introduce a simple check that the extension of the file it tries to load is indeed a yaml-file (or at least, it checks that the file says it is a yaml-file).
Summary by CodeRabbit
.yamlfiles are processed when loading intent responses, preventing potential errors from non-YAML files.