|
|
|
@@ -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.1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Automatically update using Dependabot
|
|
|
|
|
|
|
|
|
|
The advantage of locking against a more specific version, is that it prevent
|
|
|
|
|
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 but 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
|
|
|
|
|