diff --git a/.github/workflows/release-tracker.yaml b/.github/workflows/release-tracker.yaml new file mode 100644 index 0000000..f60daa7 --- /dev/null +++ b/.github/workflows/release-tracker.yaml @@ -0,0 +1,22 @@ +--- +name: Release Tracker + +# yamllint disable-line rule:truthy +on: + push: + tags: + - v[0-9]+.[0-9]+.[0-9]+ + workflow_dispatch: + +jobs: + release-tracker: + name: ๐Ÿท Release Tracker + runs-on: ubuntu-latest + steps: + - name: โคต๏ธ Check out code from GitHub + uses: actions/checkout@v2 + with: + fetch-depth: 0 + ref: main + - name: ๐Ÿš€ Run Release Tracker + uses: bewuethr/release-tracker-action@v1.2.0 diff --git a/README.md b/README.md index 80ad1a1..db0d202 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,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