|
|
|
@@ -52,7 +52,7 @@ By default, this GitHub Action will use the root folder as the Home Assistant
|
|
|
|
|
Core configuration folder. If you store your Home Assistant configuration in a
|
|
|
|
|
subfolder, the `path` argument can be used to inform the Action about that.
|
|
|
|
|
|
|
|
|
|
For example, if you configuration is in the `config` folder:
|
|
|
|
|
For example, if your configuration is in the `config` folder:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: 🚀 Run Home Assistant Core Configuration Check
|
|
|
|
@@ -71,7 +71,7 @@ This GitHub Action offers a way around that, but using a fake secrets file.
|
|
|
|
|
To use this, add a fake secrets file to your repository (e.g.,
|
|
|
|
|
`fakesecrets.yaml`) and make sure the content is the same as your real
|
|
|
|
|
`secrets.yaml` (with, of course, fake credentials/data). The GitHub Action
|
|
|
|
|
will use this file during checking your configuration.
|
|
|
|
|
will use this file while checking your configuration.
|
|
|
|
|
|
|
|
|
|
For example, if you fake secrets file is `fakesecrets.yaml`:
|
|
|
|
|
|
|
|
|
@@ -91,7 +91,7 @@ folder.
|
|
|
|
|
|
|
|
|
|
If the `.HA_VERSION` file is found, the version in that file is used. If
|
|
|
|
|
the `.HA_VERSION` file is not found; the Action will use the latest stable
|
|
|
|
|
version of Home Assistant to test your configuration with.
|
|
|
|
|
version of Home Assistant to test your configuration.
|
|
|
|
|
|
|
|
|
|
However, you can specify/override any version you like to check against,
|
|
|
|
|
for example, check with Home Assistant Core `2021.1.0`:
|
|
|
|
@@ -104,7 +104,7 @@ for example, check with Home Assistant Core `2021.1.0`:
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Alternatively, you can also use `stable`, `beta` or `dev` to run against
|
|
|
|
|
latest versions of those stability channels.
|
|
|
|
|
the latest versions of those stability channels.
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: 🚀 Run Home Assistant Core Configuration Check
|
|
|
|
@@ -139,6 +139,16 @@ jobs:
|
|
|
|
|
version: "${{ matrix.version }}"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Real-world examples
|
|
|
|
|
|
|
|
|
|
The following repositories are using this GitHub Action, and thus provide
|
|
|
|
|
you with some real-world uses of this GitHub Action.
|
|
|
|
|
|
|
|
|
|
- [Frenck's Home Assistant Configuration](https://github.com/frenck/home-assistant-config)
|
|
|
|
|
|
|
|
|
|
Are you using this GitHub Action? Feel free to open up a PR to add your
|
|
|
|
|
configuration to this list 😍
|
|
|
|
|
|
|
|
|
|
## Changelog & Releases
|
|
|
|
|
|
|
|
|
|
This repository keeps a change log using [GitHub's releases][releases]
|
|
|
|
@@ -152,6 +162,63 @@ based on the following:
|
|
|
|
|
- `MINOR`: Backwards-compatible new features and enhancements.
|
|
|
|
|
- `PATCH`: Backwards-compatible bugfixes and package updates.
|
|
|
|
|
|
|
|
|
|
## Versions & Updating
|
|
|
|
|
|
|
|
|
|
You can specify which version of this GitHub Action your workflow should use.
|
|
|
|
|
And even allowing for using the latest major or minor version.
|
|
|
|
|
|
|
|
|
|
For example; this will use release `v1.1.1` of a GitHub Action:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: 🚀 Run Home Assistant Configuration Check
|
|
|
|
|
uses: frenck/action-home-assistant@v1.1.1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
While the following example, will use the `v1.1.x` minor release, for example
|
|
|
|
|
if `v1.1.2` is the latest releases (starting with `v1.1`), this will run
|
|
|
|
|
`v1.1.2`:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: 🚀 Run Home Assistant Configuration Check
|
|
|
|
|
uses: frenck/action-home-assistant@v1.1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
As in the examples throughout the documentation, the following example is
|
|
|
|
|
locked on major version, meaning any `v1.x.x` latest version will be used,
|
|
|
|
|
as long as it is version 1.
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: 🚀 Run Home Assistant Configuration Check
|
|
|
|
|
uses: frenck/action-home-assistant@v1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Automatically update using Dependabot
|
|
|
|
|
|
|
|
|
|
The advantage of locking against a more specific version, is that it prevents
|
|
|
|
|
surprises if an issue or breaking changes were introduced in a newer release.
|
|
|
|
|
|
|
|
|
|
The disadvantage of being more specific, is that it requires you to keep things
|
|
|
|
|
up to date. Fortunately, GitHub has a tool for that, called: Dependabot.
|
|
|
|
|
|
|
|
|
|
Dependabot can automatically open a pull request on your repository to update
|
|
|
|
|
this Action for you. You can instantly see if the new version works (as the
|
|
|
|
|
pull request shows the success or failure status) and you can decide to
|
|
|
|
|
merge it in by hitting the merge button. Quick, easy and always up2date.
|
|
|
|
|
|
|
|
|
|
To enable Dependabot, create a file called `.github/dependabot.yaml`:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
version: 2
|
|
|
|
|
updates:
|
|
|
|
|
- package-ecosystem: "github-actions"
|
|
|
|
|
directory: "/"
|
|
|
|
|
schedule:
|
|
|
|
|
interval: daily
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Your all set! Dependabot will now check (and update) your GitHub actions
|
|
|
|
|
every day. 🤩
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
This is an active open-source project. We are always open to people who want to
|
|
|
|
|
Franck Nijhof