GitHub Behind the scenes

While this repo is to maintain my Home Assistant configuration I also leverage a number of other features GitHub provides.

• I use issues to track my ideas, work and research.
• This wiki is full of helpful guides I create during my work.
• Using GitHub Bots I'm able to create a weekly newsletter of all my issues and also to mark issues as stale when there hasn't been any activity for a period.
• To avoid losing track of my work and also break things down into more manageable tasks I use projects to help me organise my issues.
• I'm gradually synchronising my local config to this repo.
• I plan to use workflow and actions to provide me with CI testing etc
• With the help from commit history, I hope to be able to share my progress and detail my work.

Actions

Label Commenter

I use a GitHub action to comment on my issues when certain labels are added. This is mainly to add documentation so I have all the information in one place.

1. Create a new personal access token and add it in as a secret within the repo.
2. Create a new workflow .github/workflows/label-commenter.yml.

# .github/workflows/label-commenter.yml

name: Label Commenter

on:
  issues:
    types:
      - labeled
      - unlabeled
  pull_request:
    types:
      - labeled
      - unlabeled

jobs:
  comment:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v2
        with:
          ref: master

      - name: Label Commenter
        uses: peaceiris/actions-label-commenter@v1
        with:
          github_token: ${{ secrets.token }}
          # config_file: .github/label-commenter-config.yml

3. Then create a .github/label-commenter-config.yml configuration file which defines what actions happen when a tag is matched.

labels:
  - name: "integration: utility_meter"
    labeled:
      issue:
        body: "#HomeAssistant ```utility_meter``` integration documentation - https://www.home-assistant.io/integrations/utility_meter/"

Badges

Here are some examples of how you can show badges in readme files.

<div align="center">
  <h4>
    <a href="https://travis-ci.org/jcallaghan/home-assistant-config"><img src="https://travis-ci.org/jcallaghan/home-assistant-config.svg?branch=master"/></a>
    <a href="https://github.com/jcallaghan/home-assistant-config/stargazers"><img src="https://img.shields.io/github/stars/jcallaghan/home-assistant-config.svg?style=plasticr"/></a>
    <a href="https://github.com/jcallaghan/home-assistant-config/commits/master"><img src="https://img.shields.io/github/last-commit/jcallaghan/home-assistant-config.svg?style=plasticr"/></a>
  </h4>
</div>

![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE.md)

[![GitHub Activity][commits-shield]][commits]
[![GitHub Last Commit][last-commit-shield]][commits]

[![Discord francophone][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]

[commits-shield]: https://img.shields.io/github/commit-activity/y/jcallaghan/home-assistant-config
[commits]: https://github.com/jcallaghan/home-assistant-config/commits/master
[discord-shield]: https://img.shields.io/discord/542746125292273674?label=Discord%20jamescallaghan&logo=discord
[discord]: https://discord.gg/JeTFJzE$
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/?u=jcallaghan
[last-commit-shield]: https://img.shields.io/github/last-commit/jcallaghan/home-assistant-config.svg
[license-shield]: https://img.shields.io/github/license/jcallaghan/home-assistant-config.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
[workflow-shield]: https://github.com/jcallaghan/home-assistant-config/workflows/Home%20Assistant%20Config/badge.svg
[workflow]: https://github.com/jcallaghan/home-assistant-config/actions