Clarify external packages must have source code published

[emontnemery]

Proposed change

Clarify external packages must have source code published

We could also extend this with:

• Require source code is published on github or some other similar service
• Require source code on github matches the source distribution published on PyPi (except for publishing actions such as injecting version tag etc.)
• Require that the package has a public and transparent release management process on the CI of the package

Type of change

• [ ] Document existing features within Home Assistant
• [ ] Document new or changing features which there is an existing pull request elsewhere
• [ ] Spelling or grammatical corrections, or rewording for improved clarity
• [ ] Changes to the backend of this documentation
• [ ] Removed stale or deprecated documentation

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request:

[frenck]

PS: I would agree on adding all suggested extensions in the PR description.

[joostlek]

Would it be good to clarify a migration path? Because not every dependency has the transparent CI, and I think its a good thing if we start requiring it at some point

[frenck]

Would it be good to clarify a migration path?

We don't have too. We can start applying the rules to new integrations / new dependencies as of now and encourage others to do so.

[bdraco]

Should we also list that it needs an OSI approved license?

[rytilahti]

Should we also list that it needs an OSI approved license?

That'd make sense, IMO, as it gives clarity for the reason we want to have the source code available. I would think that the potential extensions mentioned in the description, e.g., a requirement for an open issue tracker (esp. for homeassistant-only libraries), having a repository hosted at service X, or requiring specific build & release procedures would be much more controversial than requiring an OSI-approved license :-)

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@emontnemery has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 38 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between a80d1974d6e82ed32e72ce5127ae783db6b29285 and f4792991f2d28c669603634e2c37e13d2ef5dc70.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[emontnemery]

@c0ffeeca7 there's some mistake in my changes making the build fail. Any idea what is wrong?

[c0ffeeca7]

@c0ffeeca7 there's some mistake in my changes making the build fail. Any idea what is wrong?

looking...