jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update TravisCi component configuration variable (#6726)

Browse Source 
* Update TravisCi component configuration variable

* 🚑 Try to fix

* Remove scan_interval
This commit is contained in:
Klaas Schoute 2018-10-13 00:05:47 +02:00 committed by Fabian Affolter
parent c70d845103
commit f9c3aa9b1d
1 changed files with 32 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
source/_components/sensor.travisci.markdown
View File

@ -24,16 +24,35 @@ sensor:
api_key: 123456789
```
Configuration variables:
- **api_key** (*Required*): GitHub [access token](https://github.com/settings/tokens) with the following scopes: *read:org*, *user:email*, *repo_deployment*, *repo:status*, *write:repo_hook*.
- **branch** (*Optional*): Determine which default branch should be used by the **state** condition. Defaults to *master*.
- **scan_interval** (*Optional*): How frequently to query for new data. Defaults to 30 seconds.
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
- **last_build_id**: Turn the last build job ID.
- **last_build_duration**: Return the time elapsed in seconds to run the last test job.
- **last_build_finished_at**: Return the timestamp of when the last test job finished.
- **last_build_started_at**: Return the timestamp of when the last test job started.
- **last_build_state**: Return the state from the latest test job/PR. The conditions can be: 'passed', 'failed' or 'started'.
- **state**: Return the build test from the branch specified at by **branch** parameter.
- **repository:** array (*Optional*): Name from the GitHub repositories to be monitored. If not specified, all GitHub repositories linked to Travis-CI will be enabled by default.
{% configuration %}
api_key:
description: "GitHub [access token](https://github.com/settings/tokens) with the following scopes: *read:org*, *user:email*, *repo_deployment*, *repo:status*, *write:repo_hook*."
required: true
type: string
branch:
description: "Determine which default branch should be used by the **state** condition."
required: false
default: master
type: string
monitored_conditions:
description: Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
required: false
type: list
keys:
last_build_id:
description: Turn the last build job ID.
last_build_duration:
description: Return the time elapsed in seconds to run the last test job.
last_build_finished_at:
description: Return the timestamp of when the last test job finished.
last_build_started_at:
description: Return the timestamp of when the last test job started.
last_build_state:
description: "Return the state from the latest test job/PR. The conditions can be: 'passed', 'failed' or 'started'."
state:
description: "Return the build test from the branch specified at by **branch** parameter."
repository:
description: Name from the GitHub repositories to be monitored. If not specified, all GitHub repositories linked to Travis-CI will be enabled by default.
required: false
type: list
{% endconfiguration %}