You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/docs/contribute/maintainer.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This page should contain:
8
8
9
9
- information about CI/bots/services.
10
10
- How releases are handled.
11
-
- How versions is handled.
11
+
- How versions are handled.
12
12
13
13
14
14
@@ -26,16 +26,16 @@ This applies to repositories that fall into these categories:
26
26
27
27
HACS is prepared to handle those, and this is the flow of it:
28
28
29
-
1. The repository is marked as dangerous/have security issues, by someone opening an issue in https://github.com/hacs/default repository using the "Flag" issue template.
30
-
2. The issue is reviewed, if the repository is considered to be of a critical character:
29
+
1. The repository is marked as dangerous/has security issues, by someone opening an issue in [the HACS repository](https://github.com/hacs/default) using the "Flag" issue template.
30
+
2. The issue is reviewed if the repository is considered to be of a critical character:
31
31
1. A PR is opened to add the repository to https://github.com/hacs/default/blob/master/critical
32
32
2. That PR will have a description of why, and extra steps you need to take.
33
33
3. When it's merged, HACS will know about it during the next scan (30min or Home Assistant restart.)
34
34
3. HACS receives an updated [critical file](https://github.com/hacs/default/blob/master/critical).
35
35
36
-
### If the repository is download with HACS
36
+
### If the repository is downloaded with HACS
37
37
38
-
1. The repository files is removed.
38
+
1. The repository files are removed.
39
39
2. The repository is removed from HACS.
40
40
3. Home Assistant is restarted to make sure it's not loaded anymore.
41
41
4. When Home Assistant starts up, you will have a `critical` log entry, and a persistent notification telling you to open the HACS panel.
@@ -47,8 +47,8 @@ If you click the "More info about this incident" button you will be taken to the
47
47
48
48
If you click the "Acknowledge" button, you will not see that message anymore.
49
49
50
-
### If the repository is not download with HACS
50
+
### If the repository is not downloaded with HACS
51
51
52
52
1. The repository is removed from HACS.
53
53
54
-
_That's it, since it was not download, no further action from HACS is necessary_
54
+
_That's it, since it was not downloaded, no further action from HACS is necessary_
Copy file name to clipboardExpand all lines: source/docs/contribute/translation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,8 @@ To help out with the translation of HACS you need an account on Lokalise, the ea
12
12
13
13
When you have created your account [click here to join the HACS project on Lokalise](https://lokalise.com/public/854515055f679055040b37.42677693/).
14
14
15
-
If you are unsure on how to proceed their documentation is really good, and you can [find that here](https:/.lokalise.com/en/). Or send me a message @ [discord](https://discord.gg/apgchf8) (username: `ludeeus#4212`)
15
+
If you are unsure of how to proceed, their documentation is really good, and you can [find that here](https://lokalise.com/en/). Or send me a message @ [discord](https://discord.gg/apgchf8) (username: `ludeeus#4212`)
16
16
17
17
Before each release new translations are pulled from Lokalise, so if you have added something look for it in the next version of HACS.
18
18
19
-
If you add elements to the UI of HACS that needs translations, update the [`en.json`](https://github.com/hacs/frontend/blob/master/src/localize/languages/en.json) file, when your PR are merged those new keys will be added to Lokalise ready to be translated.
19
+
If you add elements to the UI of HACS that need translations, update the [`en.json`](https://github.com/hacs/frontend/blob/master/src/localize/languages/en.json) file, when your PR is merged, those new keys will be added to Lokalise, ready to be translated.
Copy file name to clipboardExpand all lines: source/docs/faq/addons.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,6 @@ description: 'NO, no, nope, this is not an add-on, and does not handle add-ons'
11
11
12
12
## The exception
13
13
14
-
With all rules, there will at sompoint exist exceptions.
14
+
With all rules, there will be exceptions at some point.
15
15
16
-
For HACS and add-ons that is now the [Get HACS add-on](https://github.com/hacs/addons) that was made for Home Assistatnt Operating System and Supervised to simplify the initial download of HACS itself.
16
+
For HACS and add-ons that is now the [Get HACS add-on](https://github.com/hacs/addons) that was made for Home Assistant Operating System and Supervised to simplify the initial download of HACS itself.
Copy file name to clipboardExpand all lines: source/docs/publish/action.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,24 +7,24 @@ description: "Use GitHub Actions to validate your repository with HACS"
7
7
You can use GitHub actions to validate your repository with HACS.
8
8
This will make sure that your repository can be validated in HACS after changes to your repository or HACS itself.
9
9
10
-
This action uses the exact same code as HACS to validate a repository.
10
+
This action uses the same code as HACS to validate a repository.
11
11
12
-
The action have 3 run types:
12
+
The action has 3 run types:
13
13
14
14
- For the [hacs/default repo](https://github.com/hacs/default) it is used to validate new default repositories.
15
15
- If you use releases the latest release will be checked, if not the default branch will be checked.
16
-
- If you have it set up for PR's in your repository, it will run against the fork/branch that made the PR.
17
-
- If you have it set up for pushes, if will run against the branch you push to.
16
+
- If you have it set up for PRs in your repository, it will run against the fork/branch that made the PR.
17
+
- If you have it set up for pushes, it will run against the branch you push to.
18
18
19
19
The action itself lives [here](https://github.com/hacs/action) and you are free to inspect the code and/or make a PR to add changes.
20
20
21
21
To use it, follow these steps:
22
22
23
23
1. Go to your repository on GitHub
24
24
1. Click on "Create new file"
25
-
1. For filename, paste .github/workflows/validate.yaml
25
+
1. For the filename, paste .github/workflows/validate.yaml
26
26
1. Paste the following contents:
27
-
1. Change the value of `category` key, this needs to be one of: `appdaemon`, `integration`, `plugin`:material-information-outline:{ title="Plugin is the old name for dashboard but it is still used in the backend" }, `python_script`, `template`, `theme`
27
+
1. Change the value of the `category` key, this needs to be one of: `appdaemon`, `integration`, `plugin`:material-information-outline:{ title="Plugin is the old name for dashboard but it is still used in the backend" }, `python_script`, `template`, `theme`
28
28
29
29
```yaml title=".github/workflows/validate.yml"
30
30
name: Validate
@@ -46,7 +46,7 @@ jobs:
46
46
category: "CHANGE_ME!"
47
47
```
48
48
49
-
This will run on every PR and push, and at midnight every day. And `workflow_dispatch` allows you to run the action on demand from the Actions tab.
49
+
This will run on every PR and push and at midnight every day. And `workflow_dispatch` allows you to run the action on demand from the Actions tab.
50
50
51
51
!!! tip
52
52
If you maintain an integration, you can also validate your integration with [hassfest](https://developers.home-assistant.io/blog/2020/04/16/hassfest).
Copy file name to clipboardExpand all lines: source/docs/publish/include.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Include default repositories
4
4
description: 'Include default repositories'
5
5
---
6
6
7
-
As a developer you can now add your repository to be included in as a default repository in the store.
7
+
As a developer, you can now add your repository to be included as a default repository in the store.
8
8
9
9
Only the owner of the repository or a major contributor to it can submit a PR to have it included as a default.
10
10
@@ -19,9 +19,9 @@ Add both these actions to your own repository and make sure they pass:
19
19
-https://github.com/home-assistant/actions#hassfest (only for integrations)
20
20
-https://github.com/hacs/action
21
21
22
-
When all of this is covered, you can add it to repository type files in https://github.com/hacs/default
22
+
When all of this is covered, you can add it to repository type files at [https://github.com/hacs/default](https://github.com/hacs/default)
23
23
24
-
In your fork of `hacs/default`, create a new branch for your changes from the `master`branch. Do **not** use the`master` branch directly for your changes.
24
+
In your fork of `hacs/default`, create a new branch for your changes from the `master`branch. Do **not** use the`master` branch directly for your changes.
25
25
26
26
Your PR needs to be editable, so you can not submit it from an organization.
27
27
@@ -34,13 +34,13 @@ When a PR for this is merged, it will show up in HACS after the first scheduled
34
34
## CI Checks
35
35
36
36
When submitting a repository for the default repository a suite of CI checks will be run to ensure that the repository follows the requirements.
37
-
All checks needs to pass for the repository to be included (unless something else are agreed on).
37
+
All checks need to pass for the repository to be included (unless something else is agreed on).
38
38
39
39
### Check Brands
40
40
41
41
_Only applies to integrations._
42
42
43
-
This checks that the repository are added to https://github.com/home-assistant/brands
43
+
This checks that the repository is added to [https://github.com/home-assistant/brands](https://github.com/home-assistant/brands)
44
44
45
45
### Check Manifest
46
46
@@ -88,11 +88,11 @@ This checks general things about the repository like:
88
88
89
89
### Lint [jq]
90
90
91
-
This make sure that the files still are valid JSON.
91
+
This makes sure that the files still are valid JSON.
92
92
93
93
### Lint [sorted]
94
94
95
-
This make sure that the files still are sorted correctly.
95
+
This makes sure that the files still are sorted correctly.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?v=4&size=40){kind=avatar}
0 commit comments