Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify external packages must have source code published #2172

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

emontnemery
Copy link
Contributor

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:

docs/api_lib_index.md Outdated Show resolved Hide resolved
docs/api_lib_index.md Outdated Show resolved Hide resolved
docs/api_lib_index.md Outdated Show resolved Hide resolved
docs/development_checklist.md Outdated Show resolved Hide resolved
@frenck
Copy link
Member

frenck commented May 15, 2024

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

@joostlek
Copy link
Member

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
Copy link
Member

frenck commented May 15, 2024

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
Copy link
Member

bdraco commented May 20, 2024

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

@rytilahti
Copy link
Member

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 :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants