CI, linting, refactoring, cleanup, labeling, stuff (#21)

.github/funding.yaml

@@ -0,0 +1,4 @@
+---
+github: frenck
+patreon: frenck
+custom: https://frenck.dev/donate/

.github/labels.yml

@@ -0,0 +1,86 @@
+---
+- name: "breaking-change"
+  color: ee0701
+  description: "A breaking change for existing users."
+- name: "bugfix"
+  color: ee0701
+  description: "Inconsistencies or issues which will cause a problem for users or implementors."
+- name: "documentation"
+  color: 0052cc
+  description: "Solely about the documentation of the project."
+- name: "enhancement"
+  color: 1d76db
+  description: "Enhancement of the code, not introducing new features."
+- name: "refactor"
+  color: 1d76db
+  description: "Improvement of existing code, not introducing new features."
+- name: "performance"
+  color: 1d76db
+  description: "Improving performance, not introducing new features."
+- name: "new-feature"
+  color: 0e8a16
+  description: "New features or options."
+- name: "maintenance"
+  color: 2af79e
+  description: "Generic maintenance tasks."
+- name: "ci"
+  color: 1d76db
+  description: "Work that improves the continue integration."
+- name: "dependencies"
+  color: 1d76db
+  description: "Upgrade or downgrade of project dependencies."
+
+- name: "in-progress"
+  color: fbca04
+  description: "Issue is currently being resolved by a developer."
+- name: "stale"
+  color: fef2c0
+  description: "There has not been activity on this issue or PR for quite some time."
+- name: "no-stale"
+  color: fef2c0
+  description: "This issue or PR is exempted from the stable bot."
+
+- name: "security"
+  color: ee0701
+  description: "Marks a security issue that needs to be resolved asap."
+- name: "incomplete"
+  color: fef2c0
+  description: "Marks a PR or issue that is missing information."
+- name: "invalid"
+  color: fef2c0
+  description: "Marks a PR or issue that is missing information."
+
+- name: "beginner-friendly"
+  color: 0e8a16
+  description: "Good first issue for people wanting to contribute to the project."
+- name: "help-wanted"
+  color: 0e8a16
+  description: "We need some extra helping hands or expertise in order to resolve this."
+
+- name: "hacktoberfest"
+  description: "Issues/PRs are participating in the Hacktoberfest."
+  color: fbca04
+- name: "hacktoberfest-accepted"
+  description: "Issues/PRs are participating in the Hacktoberfest."
+  color: fbca04
+
+- name: "priority-critical"
+  color: ee0701
+  description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
+- name: "priority-high"
+  color: b60205
+  description: "After critical issues are fixed, these should be dealt with before any further issues."
+- name: "priority-medium"
+  color: 0e8a16
+  description: "This issue may be useful, and needs some attention."
+- name: "priority-low"
+  color: e4ea8a
+  description: "Nice addition, maybe... someday..."
+
+- name: "major"
+  color: b60205
+  description: "This PR causes a major version bump in the version number."
+- name: "minor"
+  color: 0e8a16
+  description: "This PR causes a minor version bump in the version number."
+

.github/release-drafter.yml

@@ -0,0 +1,57 @@
+---
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+sort-direction: ascending
+
+categories:
+  - title: "🚨 Breaking changes"
+    labels:
+      - "breaking-change"
+  - title: "✨ New features"
+    labels:
+      - "new-feature"
+  - title: "🐛 Bug fixes"
+    labels:
+      - "bugfix"
+  - title: "🚀 Enhancements"
+    labels:
+      - "enhancement"
+      - "refactor"
+      - "performance"
+  - title: "🧰 Maintenance"
+    labels:
+      - "maintenance"
+      - "ci"
+  - title: "📚 Documentation"
+    labels:
+      - "documentation"
+  - title: "⬆️ Dependency updates"
+    labels:
+      - "dependencies"
+
+version-resolver:
+  major:
+    labels:
+      - "major"
+      - "breaking-change"
+  minor:
+    labels:
+      - "minor"
+      - "new-feature"
+  patch:
+    labels:
+      - "bugfix"
+      - "chore"
+      - "ci"
+      - "dependencies"
+      - "documentation"
+      - "enhancement"
+      - "performance"
+      - "refactor"
+  default: patch
+
+template: |
+  ## What’s changed
+
+  $CHANGES

.github/workflows/black.yaml

@@ -0,0 +1,33 @@
+---
+name: Black
+
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+
+env:
+  DEFAULT_PYTHON: "3.10"
+
+jobs:
+  black:
+    name: Black
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+
+      - name: 🏗 Set up Poetry
+        run: pipx install poetry
+
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+          cache: "poetry"
+
+      - name: 🏗 Install Python dependencies
+        run: poetry install --no-interaction
+
+      - name: 🚀 Run black
+        run: poetry run black --diff --fast .

.github/workflows/hacs.yml → .github/workflows/hacs.yaml

@@ -1,26 +1,22 @@
 ---
-name: "HACS Validation"
+name: HACS Validation
 
 on:
-  workflow_dispatch:
+  pull_request:
+  push:
   schedule:
     - cron: "0 0 * * *"
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
+  workflow_dispatch:
 
 jobs:
   hacs:
-    name: "HACS Validation"
+    name: HACS Validation
     runs-on: ubuntu-latest
     steps:
-      - name: "Checkout the repository"
-        uses: actions/checkout@v3.3.0
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
 
-      - name: "Run HACS validation"
+      - name: 🚀 Run HACS validation
         uses: hacs/action@main
         with:
           category: integration

.github/workflows/hassfest.yaml

@@ -1,24 +1,20 @@
 ---
-name: "Hassfest"
+name: Hassfest
 
 on:
-  workflow_dispatch:
+  pull_request:
+  push:
   schedule:
     - cron: "0 0 * * *"
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
+  workflow_dispatch:
 
 jobs:
   hassfest:
-    name: "Hassfest"
+    name: Hassfest
     runs-on: ubuntu-latest
     steps:
-      - name: "Checkout the repository"
+      - name: ⤵️ Check out code from GitHub
         uses: actions/checkout@v3
 
-      - name: "Run hassfest validation"
+      - name: 🚀 Run hassfest validation
         uses: home-assistant/actions/hassfest@master

.github/workflows/labels.yaml

@@ -0,0 +1,23 @@
+---
+name: Sync labels
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/labels.yml
+  workflow_dispatch:
+
+jobs:
+  labels:
+    name: ♻️ Sync labels
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+
+      - name: 🚀 Run Label Syncer
+        uses: micnncim/action-label-syncer@v1.3.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr-labels.yaml

@@ -0,0 +1,20 @@
+---
+name: PR Labels
+
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled, synchronize]
+
+jobs:
+  pr_labels:
+    name: Verify
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🏷 Verify PR has a valid label
+        uses: jesusvasquez333/verify-pr-label-action@v1.4.0
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          valid-labels: >-
+            breaking-change, bugfix, documentation, enhancement,
+            refactor, performance, new-feature, maintenance, ci, dependencies
+          disable-reviews: true

.github/workflows/pylint.yaml

@@ -0,0 +1,33 @@
+---
+name: Pylint
+
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+
+env:
+  DEFAULT_PYTHON: "3.10"
+
+jobs:
+  pylint:
+    name: Pylint
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+
+      - name: 🏗 Set up Poetry
+        run: pipx install poetry
+
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+          cache: "poetry"
+
+      - name: 🏗 Install Python dependencies
+        run: poetry install --no-interaction
+
+      - name: 🚀 Run Pylint
+        run: poetry run pylint custom_components/spook

.github/workflows/release-drafter.yaml

@@ -0,0 +1,19 @@
+---
+name: Release Drafter
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  update_release_draft:
+    name: ✏️ Draft release
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🚀 Run Release Drafter
+        uses: release-drafter/release-drafter@v5.23.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml → .github/workflows/release.yaml

@@ -1,5 +1,5 @@
 ---
-name: "Release"
+name: Release
 
 on:
   release:
@@ -8,13 +8,13 @@ on:
 
 jobs:
   release:
-    name: "Release the Spook! 👻"
+    name: Release the Spook! 👻
     runs-on: ubuntu-latest
     steps:
-      - name: "⬇️ Checkout the repository"
+      - name: ⤵️ Check out code from GitHub
         uses: actions/checkout@v3
 
-      - name: "🔢 Adjust version number"
+      - name: 🔢 Adjust version number
         shell: bash
         run: |
           version="${{ github.event.release.tag_name }}"
@@ -24,13 +24,13 @@ jobs:
             -i ".version = \"${version}\"" \
             "${{ github.workspace }}/custom_components/spook/manifest.json"
 
-      - name: "📦 Created zipped release package"
+      - name: 📦 Created zipped release package
         shell: bash
         run: |
           cd "${{ github.workspace }}/custom_components/spook"
           zip spook.zip -r ./
 
-      - name: "⬆️ Upload zip to release"
+      - name: ⬆️ Upload zip to release
         uses: softprops/action-gh-release@v0.1.15
         with:
           files: ${{ github.workspace }}/custom_components/spook/spook.zip