docs: updated workflows examples and options descriptions (#772) [skip ci]
This commit is contained in:
@@ -16,19 +16,35 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
|
||||
|
||||
</details>
|
||||
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_nightscout` | `boolean` **[no]** | Displays Blood Glucose |
|
||||
| `plugin_nightscout_url` | `string` **[https://example.herokuapp.com]** | Your Nightscout site URL |
|
||||
| `plugin_nightscout_datapoints` | `number` **[12]** *{0 ≤ 𝑥}* | How many datapoints to show on the graph. 0 and 1 disable the graph. |
|
||||
| `plugin_nightscout_lowalert` | `number` **[80]** *{0 ≤ 𝑥}* | When the blood sugar is considered low |
|
||||
| `plugin_nightscout_highalert` | `number` **[180]** *{0 ≤ 𝑥}* | When the blood sugar is considered high |
|
||||
| `plugin_nightscout_urgentlowalert` | `number` **[50]** *{0 ≤ 𝑥}* | When the blood sugar is considered urgently low |
|
||||
| `plugin_nightscout_urgenthighalert` | `number` **[250]** *{0 ≤ 𝑥}* | When the blood sugar is considered urgently high |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
* ✨ New feature currently in testing on `master`/`main`
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
#### ℹ️ Examples workflows
|
||||
|
||||
[➡️ Available options for this plugin](metadata.yml)
|
||||
|
||||
<!--examples-->
|
||||
```yaml
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
# ... other options
|
||||
plugin_nightscout: yes
|
||||
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }} # Use the github actions "NIGHTSCOUT_URL" secret as your nightscout site
|
||||
plugin_nightscout_datapoints: 12 # Use the latest 12 blood sugar datapoints to create a graph
|
||||
plugin_nightscout_lowalert: 80 # Blood sugars below 80 will be considered low
|
||||
plugin_nightscout_highalert: 180 # Blood sugars above 180 will be considered high
|
||||
plugin_nightscout_urgentlowalert: 50 # Blood sugars below 50 will be considered urgently low
|
||||
plugin_nightscout_urgenthighalert: 250 # Blood sugars above 250 will be considered urgently high
|
||||
```
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
plugin_nightscout: 'yes'
|
||||
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
|
||||
|
||||
```
|
||||
<!--/examples-->
|
||||
6
source/plugins/nightscout/examples.yml
Normal file
6
source/plugins/nightscout/examples.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
plugin_nightscout: yes
|
||||
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
|
||||
prod:
|
||||
skip: true
|
||||
Reference in New Issue
Block a user