Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.md #226

Closed
wants to merge 48 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
175a396
docs: update README.md
eltociear Nov 25, 2024
b4fbdec
Avoid running the HACS action in forks, because forks don't have rele…
elchininet Nov 25, 2024
0240fb6
Set the repo check in one of the steps, not in the job
elchininet Nov 25, 2024
1ba2660
Change the pull_request event by pull_request_target
elchininet Nov 25, 2024
b026c3c
Fix job condition
elchininet Nov 25, 2024
9f672c0
Change the name of the checking step
elchininet Nov 25, 2024
403d420
Remove the pull_request_target types
elchininet Nov 25, 2024
d0c4394
Avoid HACS running twice in pull requests
elchininet Nov 25, 2024
d5912ec
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
3d3e2c1
Run tests with the bundle from artifact
elchininet Nov 25, 2024
f1f9507
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
5df04ef
Do not run HAC on pull requests
elchininet Nov 25, 2024
1091dd6
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
c72e6ce
Fix workflow_run
elchininet Nov 25, 2024
89ade97
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
8883dc9
Fix workflow_run
elchininet Nov 25, 2024
b085bb1
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
31514c3
Remove unnecessary expression avaluators
elchininet Nov 25, 2024
a0a8a59
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
4da1b7f
Specify a Github Token to download the artifacts
elchininet Nov 25, 2024
dc9c864
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
462890e
Set the artifact as a folder
elchininet Nov 25, 2024
473d301
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
e8d1869
Enclose the path between quotes
elchininet Nov 25, 2024
4c3de93
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
cfb5060
Upload only the bundle as an artifact
elchininet Nov 25, 2024
2b24e00
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
e32d8b9
Always install node modules
elchininet Nov 25, 2024
0468eab
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
4dc88dd
Download the artifact in a directory
elchininet Nov 25, 2024
18c9060
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
f59deb1
Create a specific worflow for testing PR
elchininet Nov 25, 2024
30fef12
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
eddcb5c
Change PR test job name
elchininet Nov 25, 2024
700a3f7
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
843f84a
Fix identation
elchininet Nov 25, 2024
de68dc1
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
039dbc2
Specify an on trigger
elchininet Nov 25, 2024
5f5f867
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
d194753
Remove check_id
elchininet Nov 25, 2024
860cd5f
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
e1746ac
Remove git-branch and git-commit from coveralls
elchininet Nov 25, 2024
4314793
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
ca7db95
Remove id from checks action
elchininet Nov 25, 2024
59e1b50
Merge branch 'master' into patch-1
elchininet Nov 25, 2024
59fc4b8
Use head_commit instead of head_sha
elchininet Nov 26, 2024
1f77522
Merge branch 'master' into patch-1
elchininet Nov 26, 2024
843468f
Merge branch 'master' into patch-1
elchininet Nov 26, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Set-up Node
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: 20
cache: 'pnpm'
- name: Install deps
run: pnpm install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ha-beta-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: 20
cache: 'pnpm'
- name: Install
run: pnpm install
Expand Down
29 changes: 29 additions & 0 deletions .github/workflows/pull-request-received.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: PR Created

on:
pull_request:

jobs:
build:
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install pnpm
uses: pnpm/action-setup@v3
with:
version: 9
run_install: false
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'pnpm'
- name: Install
run: pnpm install
- uses: actions/upload-artifact@v4
with:
name: pr-bundle
include-hidden-files: true
path: .hass/
retention-days: 30
82 changes: 82 additions & 0 deletions .github/workflows/test-pr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Test PR

on:
workflow_run:
workflows:
- PR Created
types:
- completed

jobs:
test-pr:
runs-on: ubuntu-22.04
if: github.event.workflow_run.conclusion == 'success'
steps:
- name: Set initial status for tests
id: test_check
uses: LouisBrunner/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
name: test
sha: ${{ github.event.workflow_run.head_sha }}
status: in_progress
- name: Set initial status for coverage
uses: LouisBrunner/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
name: coverage/coveralls
sha: ${{ github.event.workflow_run.head_sha }}
status: in_progress
- name: Checkout
uses: actions/checkout@v4
- name: Install pnpm
uses: pnpm/action-setup@v3
with:
version: 9
run_install: false
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'pnpm'
- name: Install
run: pnpm install --ignore-scripts
- name: Download bundle from artifact
uses: actions/download-artifact@v4
with:
name: pr-bundle
run-id: ${{ github.event.workflow_run.id }}
path: ${{ github.workspace }}
github-token: ${{ github.token }}
- name: E2E tests
id: tests
run: |
touch .env
echo HA_TOKEN=${{ secrets.HA_TOKEN }} >> .env
pnpm test:all
- name: Create coverage
run: pnpm coverage:report
- name: Coveralls
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
git-branch: ${{ github.event.workflow_run.head_branch }}
git-commit: ${{ github.event.workflow_run.head_commit.id }}
#debug: true
- uses: actions/upload-artifact@v3
if: always()
with:
name: test-report
path: |
playwright-report/
coverage/
retention-days: 30
- name: Set final status for tests
uses: LouisBrunner/[email protected]
if: always()
with:
token: ${{ secrets.GITHUB_TOKEN }}
check_id: ${{ steps.test_check.outputs.check_id }}
sha: ${{ github.event.workflow_run.head_sha }}
status: completed
conclusion: ${{ job.status }}
2 changes: 1 addition & 1 deletion .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: 20
cache: 'pnpm'
- name: Install
run: pnpm install
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Custom [HACS] plugin that allows you to personalise the [Home Assistant]'s sideb
</tbody>
</table>

This is a refactor of [custom-sidebar-v2] by @galloween, which unfortunatelly is now unmaintained and archived. In its beginning, @galloween's code was a refactor of the [original Custom Sidebar] plugin by @Villhellm (R.I.P.). This version refactored completely @galloween's code allowing to use a configuration in `YAML` (as @Villhellm's one) or in `JSON` (as @galloween's version), fixing several bugs, improving performance, and using [home-assistant-query-selector] to make it less likely to break with future Home Assistant front-end updates.
This is a refactor of [custom-sidebar-v2] by @galloween, which unfortunately is now unmaintained and archived. In its beginning, @galloween's code was a refactor of the [original Custom Sidebar] plugin by @Villhellm (R.I.P.). This version refactored completely @galloween's code allowing to use a configuration in `YAML` (as @Villhellm's one) or in `JSON` (as @galloween's version), fixing several bugs, improving performance, and using [home-assistant-query-selector] to make it less likely to break with future Home Assistant front-end updates.

## Installation

Expand Down
Loading