GitHub integration revamp #38458
GitHub integration revamp #38458
Conversation
This comment has been minimized.
This comment has been minimized.
|
Really cool, was thinking about this myself the other day, mainly to have webhook support or things like services to create issues (out of scope for now 😉) Nevertheless, GitHub support OAuth2, why not leverage that? |
Well that's in the package, so yeah, future enhancement 😉 Was also thinking about adding actions/ci if that's accessable, but again, keep this simple, add later 😀
I'll take a look. Main reason was simplicity 😄 Edit: I find that tokens are much simpler and don't require multiple IDs and a new app creating. Feel free to add of course but I prefer the current method for this pr |
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. |
timmo001
force-pushed
the
github-revamp
branch
4 times, most recently
from
e8d919c to
dcf97d0
Compare
timmo001
force-pushed
the
github-revamp
branch
from
e9ecaa8 to
31712fe
Compare
| { | ||
| "title": "GitHub", | ||
| "config": { | ||
| "flow_title": "GitHub: {repository}", | ||
| "step": { | ||
| "reauth": { | ||
| "title": "GitHub: Reauthentication", | ||
| "description": "Please re-enter your [access token](https://github.com/settings/tokens).", | ||
| "data": { | ||
| "access_token": "Access Token" | ||
| } | ||
| }, | ||
| "user": { | ||
| "description": "Please enter your [access token](https://github.com/settings/tokens) and repository (`org/project`).", | ||
| "data": { | ||
| "access_token": "Access Token", | ||
| "repository": "Repository" | ||
| } | ||
| } | ||
| }, | ||
| "error": { | ||
| "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]", | ||
| "cannot_find_repo": "Cannot find repository", | ||
| "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]", | ||
| "unknown": "[%key:common::config_flow::error::unknown%]" | ||
| }, | ||
| "abort": { | ||
| "already_configured": "[%key:common::config_flow::abort::already_configured_account%]", | ||
| "connection_error": "There was an error connecting to GitHub.", | ||
| "reauth_successful": "[%key:common::config_flow::data::access_token%] updated successfully" | ||
| } | ||
| }, | ||
| "options": { | ||
| "step": { | ||
| "user": { | ||
| "title": "GitHub Options", | ||
| "description": "To help reduce the chances of hitting API limits, some items have been disabled by default. You can enable and disable these items here.", | ||
| "data": { | ||
| "clones": "Clones", | ||
| "issues_and_prs": "Issues and Pull Requests", | ||
| "latest_commit": "Latest Commit", | ||
| "latest_release": "Latest Release", | ||
| "views": "Views" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
I think the en translation is not needed in the commit.
| "ssdp": [], | ||
| "zeroconf": [], | ||
| "homekit": {}, | ||
| "dependencies": [], |
There was a problem hiding this comment.
Can be ommitted if blank?
|
We should not hard break it to add config flow, there should be a grace period of 2 releases where the configuration is imported. |
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. |
|
I'll revisit this at some point. I've seen a few package updates also |
|
Think I'll close this and let someone else take it or come back to it at some point since its became pretty old and stale at this point 😸 |
Breaking change
YAML config has been removed. This is replaced with the configuration in the user interface.
The sensor has also been split into individual sensors for each type with a subset enabled to start. You can enable more via the integration's options.
Proposed change
A rewrite of the GitHub integration with a config flow, coordinator, split sensors and a new package without I/O in the event loop.
Clones and Views are removed from the options flow for repos without push access. Only latest commit is selected for initial setup. (to reduce API hits)
Type of change
Additional information
Checklist
black --fast homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.The integration reached or maintains the following Integration Quality Scale: