Skip to content

Commit

Permalink
Add github action documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed Apr 24, 2020
1 parent 4eee770 commit 39a1fb8
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 200 deletions.
51 changes: 51 additions & 0 deletions documentation/publish/action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: action
title: GitHub Action
description: "Use GitHub Actions to validate your repository with HACS"
---

You can use GitHub actions to validate your repository with HACS.
This will make sure that your repository can be validated in HACS after changes to your repository or HACS itself.


The action have 3 run types:

- For the [hacs/default repo](https://github.com/hacs/default) it is used to validate new default repositories.
- If you have it set up for PR's in your repository, it will run against the fork/branch that made the PR.
- If you have it set up for pushes, if will run against the branch you push to.

The action itself lives [here](https://github.com/hacs/integration/tree/master/action) and you are free to inspect the code and/or make a PR to add changes.

To intall it, follow these steps:

1. Go to your repository on GitHub
1. Click on "Create new file"
1. For filename, paste .github/workflows/validate.yaml
1. Paste the following contents:
1. Change the value of "CATEGORY" key, this needs to be one of: "appdaemon", "integration", "netdaemon", "plugin", "python_script", "theme"

```yaml .github/workflows/validate.yml
name: Validate

on:
push:
pull_request:
schedule:
- cron: "0 0 * * *"

jobs:
validate:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v2"
- name: HACS validation
uses: "hacs/integration/action@master"
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CATEGORY: "CHANGE_ME!"
```
This will run on every PR and push, and at midnight every day.

:::tip
If you maintain an integration, you can also validate your integration with [hassfest](https://developers.home-assistant.io/blog/2020/04/16/hassfest).
:::
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ module.exports = {
"publish/python_script",
"publish/theme",
"publish/include",
"publish/action",
"publish/blacklist"
]
},
Expand Down
Loading

0 comments on commit 39a1fb8

Please sign in to comment.