Get rid of codenotary references from addon docs #2810
Conversation
📝 WalkthroughWalkthroughRemoved all Codenotary-related configuration and security documentation from add-on docs, including options and extended build arguments in configuration, the Codenotary CAS section and related bullet in security, and the "signed with CodeNotary" security rating in presentation. No new alternatives or functional changes were introduced. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to data retention organization setting 📒 Files selected for processing (3)
💤 Files with no reviewable changes (3)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Tip 🧪 Early access (models): enabledWe are currently testing Sonnet 4.5 code review models, which should lead to better review quality. However, this model may result in higher noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience. Note:
Comment |
stuartparmenter
force-pushed
the
no-codenotary
branch
from
86826be to
4b1d313
Compare
| | codenotary | no | Enable container signature with codenotary CAS. | ||
| | codenotary.signer | no | Owner signer E-Mail address for this image. | ||
| | codenotary.base_image | no | Verify the base container image. If you use our official images, use `notary@home-assistant.io` |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
@frenck see discord developers; he found it at home-assistant/builder#182 |
|
And the supervisor? |
|
As far as I can tell, codenotary CAS (the product/offering/etc) is dead. There are various remains of it still scattered around in HA, but it was disabled home-assistant/supervisor#4217 (and that appears to still stands today). |
|
Sure but the option right now is still valid. If we clean up the docs, we need to make sure the codebase is cleaned up too. Docs are a result of the codebase change and not the other way around. |
|
The code base changes have been made already such that the options don’t do anything leaving the docs as misleading at best given they encourage its use and it doesn’t actually do anything (I wasted a good bit of time trying to get things setup, create a codenotary account, etc only to realize nothing used the options as I went to test that it worked). Should further cleanup be done to fully remove it from the supervisor, all the addons, etc? Absolutely. But given these changes were made in 2023 it seems reasonable to remove the docs while someone carefully removes the code without breaking validation |
|
I get your point; however, the documentation reflects the current implementation state. Documentation changes results from upstream cleanup, not the other way around. ../Frenck |
|
The documentation doesn't reflect the current implementation state. If the documentation was left in and all of the descriptions were changed to "this doesn't do anything" then it would. Would that be a better short term solution in your mind? |
|
This feels like such a textbook example of "Don’t let the perfect be the enemy of the good" I'm going to move on to other things. If someone wants to merge this go ahead. Hopefully other people don't waste their time because of bad documentation or trying to help fix things for others. |
3 participants
Proposed change
Codenotary CAS appears to have been discontinued in 2023 and removed from the builder workflows then as well. Removing references to it from the docs so people don't waste their time.
Type of change
Checklist
Additional information
Summary by CodeRabbit