Skip to content

Commit ef427cf

Browse files
authored
Merge pull request #279 from sfstar/feature/backport_the_changes_made_on_the_remcom_fork
Feature/backport the changes made on the remcom fork
2 parents d1611f3 + 46cf17f commit ef427cf

36 files changed

+1715
-62
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!-- READ THIS FIRST:
2+
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
3+
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
4+
-->
5+
## The problem
6+
<!--
7+
Describe the issue you are experiencing here to communicate to the
8+
maintainers. Tell us what you were trying to do and what happened.
9+
-->
10+
11+
12+
## Environment
13+
<!--
14+
Provide details about the versions you are using, which helps us to reproduce
15+
and find the issue quicker. Version information is of homeassistant found in the
16+
Home Assistant frontend: Settings -> About. The installed version of the integration can be found via HACS -> Victron GX modbus TCP
17+
-->
18+
19+
- Home Assistant Core release with the issue:
20+
- Last working Home Assistant Core release (if known):
21+
- Integration version causing this issue:
22+
23+
## Problem-relevant `configuration dialog`
24+
<!--
25+
An example configuration that caused the problem for you. Fill this out even
26+
if it seems unimportant to you. Please be sure to remove personal information
27+
like passwords, private URLs and other credentials. You can provide it as text or as an screenshot.
28+
-->
29+
30+
```yaml
31+
32+
```
33+
34+
35+
## Traceback/Error logs
36+
<!--
37+
If you come across any trace or error logs, please provide them.
38+
-->
39+
40+
```txt
41+
42+
```
43+
44+
## Additional information
45+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!--
2+
You are amazing! Thanks for contributing to our project!
3+
Please, DO NOT DELETE ANY TEXT from this template! (unless instructed).
4+
-->
5+
## Breaking change
6+
<!--
7+
If your PR contains a breaking change for existing users, it is important
8+
to tell them what breaks, how to make it work again and why we did this.
9+
This piece of text is published with the release notes, so it helps if you
10+
write it towards our users, not us.
11+
Note: Remove this section if this PR is NOT a breaking change.
12+
-->
13+
14+
15+
## Proposed change
16+
<!--
17+
Describe the big picture of your changes here to communicate to the
18+
maintainers why we should accept this pull request. If it fixes a bug
19+
or resolves a feature request, be sure to link to that issue in the
20+
additional information section.
21+
-->
22+
23+
24+
## Type of change
25+
<!--
26+
What type of change does your PR introduce to Home Assistant?
27+
NOTE: Please, check only 1! box!
28+
If your PR requires multiple boxes to be checked, you'll most likely need to
29+
split it into multiple PRs. This makes things easier and faster to code review.
30+
-->
31+
32+
- [ ] Dependency upgrade
33+
- [ ] Bugfix (non-breaking change which fixes an issue)
34+
- [ ] New integration (thank you!)
35+
- [ ] New feature (which adds functionality to an existing integration)
36+
- [ ] Deprecation (breaking change to happen in the future)
37+
- [ ] Breaking change (fix/feature causing existing functionality to break)
38+
- [ ] Code quality improvements to existing code or addition of tests
39+
40+
## Additional information
41+
<!--
42+
Details are important, and help maintainers processing your PR.
43+
Please be sure to fill out additional details, if applicable.
44+
-->
45+
46+
- This PR fixes or closes issue: fixes #
47+
- This PR is related to issue:
48+
- Link to documentation pull request:
49+
50+
## Checklist
51+
<!--
52+
Put an `x` in the boxes that apply. You can also fill these out after
53+
creating the PR. If you're unsure about any of them, don't hesitate to ask.
54+
We're here to help! This is simply a reminder of what we are going to look
55+
for before merging your code.
56+
-->
57+
58+
- [ ] The code change is tested and works locally.
59+
- [ ] There is no commented out code in this PR.
60+
- [ ] The code has been formatted using Ruff (`ruff format custom_components/victron`)

.github/issue-label-bot.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label-alias:
2+
bug: 'bug'
3+
feature_request: 'feature_request'
4+
question: 'question'

.github/labels.yml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
- name: "breaking-change"
3+
color: ee0701
4+
description: "A breaking change for existing users."
5+
- name: "bugfix"
6+
color: ee0701
7+
description: "Inconsistencies or issues which will cause a problem for users or implementors."
8+
- name: "documentation"
9+
color: 0052cc
10+
description: "Solely about the documentation of the project."
11+
- name: "enhancement"
12+
color: 1d76db
13+
description: "Enhancement of the code, not introducing new features."
14+
- name: "refactor"
15+
color: 1d76db
16+
description: "Improvement of existing code, not introducing new features."
17+
- name: "performance"
18+
color: 1d76db
19+
description: "Improving performance, not introducing new features."
20+
- name: "new-feature"
21+
color: 0e8a16
22+
description: "New features or options."
23+
- name: "maintenance"
24+
color: 2af79e
25+
description: "Generic maintenance tasks."
26+
- name: "ci"
27+
color: 1d76db
28+
description: "Work that improves the continue integration."
29+
- name: "dependencies"
30+
color: 1d76db
31+
description: "Upgrade or downgrade of project dependencies."
32+
33+
- name: "in-progress"
34+
color: fbca04
35+
description: "Issue is currently being resolved by a developer."
36+
- name: "stale"
37+
color: fef2c0
38+
description: "There has not been activity on this issue or PR for quite some time."
39+
- name: "no-stale"
40+
color: fef2c0
41+
description: "This issue or PR is exempted from the stable bot."
42+
43+
- name: "security"
44+
color: ee0701
45+
description: "Marks a security issue that needs to be resolved asap."
46+
- name: "incomplete"
47+
color: fef2c0
48+
description: "Marks a PR or issue that is missing information."
49+
- name: "invalid"
50+
color: fef2c0
51+
description: "Marks a PR or issue that is missing information."
52+
53+
- name: "beginner-friendly"
54+
color: 0e8a16
55+
description: "Good first issue for people wanting to contribute to the project."
56+
- name: "help-wanted"
57+
color: 0e8a16
58+
description: "We need some extra helping hands or expertise in order to resolve this."
59+
60+
- name: "priority-critical"
61+
color: ee0701
62+
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
63+
- name: "priority-high"
64+
color: b60205
65+
description: "After critical issues are fixed, these should be dealt with before any further issues."
66+
- name: "priority-medium"
67+
color: 0e8a16
68+
description: "This issue may be useful, and needs some attention."
69+
- name: "priority-low"
70+
color: e4ea8a
71+
description: "Nice addition, maybe... someday..."
72+
73+
- name: "major"
74+
color: b60205
75+
description: "This PR causes a major version bump in the version number."
76+
- name: "minor"
77+
color: 0e8a16
78+
description: "This PR causes a minor version bump in the version number."
79+
80+
81+
- name: "shipped"
82+
color: 006b75
83+
description: "This issue has been shipped. 🚢"
84+
- name: "on-hold"
85+
color: 0052cc
86+
description: "This issue is on hold and will not be worked on until further notice."
87+
- name: "duplicate"
88+
color: fef2c0
89+
description: "This reported issue already exists."
90+
- name: "wontfix"
91+
color: ffffff
92+
description: "This issue will not be fixed."
93+
94+
- name: "connection stability"
95+
color: 32AE82
96+
description: "Issue related to the stability of the connection."
97+
- name: "data accuracy"
98+
color: 32AE82
99+
description: "Issue related to the format or representation of returned/to be returned data."
100+
- name: "specsheet mismatch"
101+
color: d93f0b
102+
description: "Issue related to the mismatch between the victron specsheet and the actual implementation."
103+
- name: "shipping next release (do not close)🚢"
104+
color: b60205
105+
description: "This issue is scheduled to be shipped in the next release."

.github/release-drafter.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
name-template: "v$RESOLVED_VERSION"
3+
tag-template: "v$RESOLVED_VERSION"
4+
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
5+
sort-direction: ascending
6+
7+
categories:
8+
- title: "🚨 Breaking changes"
9+
labels:
10+
- "breaking-change"
11+
- title: "🐛 Bug fixes"
12+
labels:
13+
- "bugfix"
14+
- title: "✨ New features"
15+
labels:
16+
- "new-feature"
17+
- title: "🚀 Enhancements"
18+
collapse-after: 4
19+
labels:
20+
- "enhancement"
21+
- "refactor"
22+
- "performance"
23+
- title: "🧰 Maintenance"
24+
collapse-after: 4
25+
labels:
26+
- "maintenance"
27+
- "ci"
28+
- title: "📚 Documentation"
29+
collapse-after: 4
30+
labels:
31+
- "documentation"
32+
- title: "⬆️ Dependency updates"
33+
collapse-after: 4
34+
labels:
35+
- "dependencies"
36+
37+
version-resolver:
38+
major:
39+
labels:
40+
- "major"
41+
- "breaking-change"
42+
minor:
43+
labels:
44+
- "minor"
45+
- "new-feature"
46+
patch:
47+
labels:
48+
- "bugfix"
49+
- "chore"
50+
- "ci"
51+
- "decoding"
52+
- "dependencies"
53+
- "documentation"
54+
- "enhancement"
55+
- "performance"
56+
- "refactor"
57+
default: patch
58+
59+
exclude-contributors:
60+
- sfstar
61+
62+
template: |
63+
## Changes
64+
65+
$CHANGES
66+
67+
Special thanks to $CONTRIBUTORS for this release!
68+
69+
70+
autolabeler:
71+
- label: 'chore'
72+
files:
73+
- '*.md'
74+
branch:
75+
- '/documentation\/.+/'
76+
- label: 'bug'
77+
branch:
78+
- '/bugfix\/.+/'
79+
title:
80+
- '/bugfix/i'
81+
- label: 'new-feature'
82+
branch:
83+
- '/feature\/.+/'
84+
body:
85+
- '/adds/'

.github/workflows/build.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
on:
2+
release:
3+
types: [published]
4+
5+
jobs:
6+
build:
7+
name: 🚀 Release
8+
runs-on: ubuntu-latest
9+
permissions:
10+
contents: write
11+
id-token: write
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Get version
17+
id: version
18+
uses: home-assistant/actions/helpers/version@main
19+
20+
- name: 🔢 Adjust version number
21+
run: |
22+
sed -i 's/v0.0.0/${{ steps.version.outputs.version }}/' custom_components/victron/manifest.json
23+
24+
- name: 📦 Created zipped release package
25+
shell: bash
26+
run: |
27+
cd "${{ github.workspace }}/custom_components/victron"
28+
zip victron.zip ./* -x '.*'
29+
30+
- name: 🔏 Sign release package
31+
uses: sigstore/[email protected]
32+
with:
33+
inputs: ${{ github.workspace }}/custom_components/victron/victron.zip
34+
35+
- name: ⬆️ Upload zip to release
36+
uses: softprops/[email protected]
37+
with:
38+
files: ${{ github.workspace }}/custom_components/victron/victron.zip

.github/workflows/hacs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: HACS Action
22

33
on:
4-
push:
54
pull_request:
65
schedule:
76
- cron: "0 0 * * *"

.github/workflows/hassfest.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: Validate with hassfest
22

33
on:
4-
push:
54
pull_request:
65
schedule:
76
- cron: '0 0 * * *'

.github/workflows/labels.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Sync labels
3+
4+
# yamllint disable-line rule:truthy
5+
on:
6+
push:
7+
branches:
8+
- main
9+
paths:
10+
- .github/labels.yml
11+
workflow_dispatch:
12+
13+
jobs:
14+
labels:
15+
name: ♻️ Sync labels
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: ⤵️ Check out code from GitHub
19+
uses: actions/checkout@v4
20+
21+
- name: 🚀 Run Label Syncer
22+
uses: micnncim/[email protected]
23+
env:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)