Home Assistant Continuous Integration Workflow 2023


Previously, I was using TravisCI to perform checks on any changes to Home Assistant files.

Since then, TravisCI has introduced caps and pricing plans and on the free tier I ran out of credits very quickly which broke the deployment chain.

The build and test stage was never successful so it never moved onto telling Home Assistant to check if the changes need to be pulled in.

To get around this, I have moved from TravisCI to Github Actions which offers more generous runs.

Home Assistant Webhook

Everything in the previous is still relevant up to the Git Pull Add-on. The part from Travis CI automations should be removed / replaced with a new web hook trigger.

- id: "1613937312554"
alias: "^Home Assistant CI"
description: "https://community.home-assistant.io/t/guide-to-setting-up-a-fully-automated-ci-for-hassio/51576"
- platform: webhook
webhook_id: git_pull
- condition: state
entity_id: input_boolean.enable_github_integration
state: "on"
- choose:
- conditions:
- condition: template
value_template: "{{ trigger.json.key|string == states('input_text.github_pull_key') }}"
- parallel:
- service: script.send_to_home_log
message: "build :white_check_mark: passed. Pulling changes."
title: ":construction_worker: :hammer_and_wrench: GitHub"
- service: hassio.addon_start
addon: core_git_pull
- service: script.send_to_home_log
message: "Build :white_check_mark: passed but ncorrect :key: key was sent."
title: ":warning: :construction_worker: :hammer_and_wrench: GitHub :warning:"
mode: single

This might not do anything but for my own peace of mind, I check for a password in the body of the web hook call. That way, if someone gets the end point, they would also have to pass a specific password or key to match.

Create a text helper with the ID input_text.github_pull_key and put a value in the helper. Make sure you have this to hand for the next part.

Create Github Action

Github Actions use YAML file to define a workflow. I created the file the root folder of my Home Assistant configuration folder: .github/workflows/main.yaml. Using my workflow as the example (found here):

  1. yamllint: check YAML files for syntax errors.
  2. remarklint: check markdown file syntax errors.
  3. ha-stable-check: run a Home Assistant configuration check against the latest stable version of Home Assistant.
  4. ha-future-checks: run a Home Assistant configuration check against the next version of Home Assistant.
  5. deploy: Call a webhook in Home Assistant if the build was successful

There are two environment variables for the deploy part that is needed. The URL for the webhook and the key set in the helper. The secret is set at the repository level so anyone who can manage the repository will be able to see or change the secrets. This is not ideal but it works if you’re the only one managing the repository.

Follwo the instructions here to create two secrets called DEPLOYMENT_URL with the webhook URL and PULL_KEY with the password/key set in the Home Assistant helper.


When a push is made, the action will trigger. A true test would be to push your commits.


It was fairly seemless to switch and most of the work done for TravisCI was applicable. I prefer the webhook method because it’s a push rather than a poll method to check whether a build has started or completed.

About Danny

I.T software professional always studying and applying the knowledge gained and one way of doing this is to blog. Danny also has participates in a part time project called Energy@Home [http://code.google.com/p/energyathome/] for monitoring energy usage on a premise. Dedicated to I.T since studying pure Information Technology since the age of 16, Danny Tsang working in the field that he has aimed for since leaving school. View all posts by Danny → This entry was posted in Home Automation, Workflow and tagged , , , , , , , , , . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *.

All comments must go through an approval and anti-spam process before appearing on the website. Please be patience and do not re-submit your comment if it does not appear.

This site uses Akismet to reduce spam. Learn how your comment data is processed.