Skip to content

Commit 01ecdf5

Browse files
committed
Merge branch 'worlfown-markdownlinter' of https://github.com/lsiepel/openhab-addons into worlfown-markdownlinter
2 parents 6829bc2 + 8a64597 commit 01ecdf5

File tree

331 files changed

+2402
-8430
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

331 files changed

+2402
-8430
lines changed

.github/dependabot.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference
5+
6+
version: 2
7+
8+
# this would enable querying all packages from our repo first,
9+
# disabled for now as we do not want to use it. Kept for reference.
10+
#registries:
11+
# openhab-jfrog:
12+
# type: "maven-repository"
13+
# url: "https://openhab.jfrog.io/artifactory/libs-all/"
14+
15+
updates:
16+
- package-ecosystem: "github-actions" # See documentation for possible values
17+
directory: "/" # Location of package manifests
18+
schedule:
19+
interval: "weekly"
20+
open-pull-requests-limit: 10
21+
labels:
22+
- dependencies
23+
24+
- package-ecosystem: "maven" # See documentation for possible values
25+
directory: "/" # Location of package manifests
26+
schedule:
27+
interval: "weekly"
28+
open-pull-requests-limit: 15
29+
labels:
30+
- dependencies
31+
groups:
32+
jacoco:
33+
patterns:
34+
- "*jacoco*"
35+
allow:
36+
- dependency-name: "org.apache.maven.plugins:*"
37+
- dependency-name: "org.codehaus.mojo:*"
38+
- dependency-name: "*jacoco*" # code coverage tool, both tool and plugin
39+
- dependency-name: "*plugin*"
40+
ignore:
41+
- dependency-name: "com.github.jaxb-xew-plugin:jaxb-xew-plugin" # updated with core
42+
- dependency-name: "com.diffplug.spotless:spotless-maven-plugin" # updated together with SAT
43+
- dependency-name: "*graalvm*" # do not touch graalvm related stuff
44+
- dependency-name: "org.openapitools:openapi*" # updated togeter with openapi generator
45+
- dependency-name: "org.apache.openjpa:openjpa*" # should be done with openjpa upgrades"

CODEOWNERS

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,6 @@
133133
/bundles/org.openhab.binding.folding/ @fa2k
134134
/bundles/org.openhab.binding.foobot/ @airboxlab @Hilbrand
135135
/bundles/org.openhab.binding.freeathome/ @andrasU
136-
/bundles/org.openhab.binding.freebox/ @lolodomo
137136
/bundles/org.openhab.binding.freeboxos/ @clinique
138137
/bundles/org.openhab.binding.freecurrency/ @J-N-K
139138
/bundles/org.openhab.binding.frenchgovtenergydata/ @clinique
@@ -170,7 +169,7 @@
170169
/bundles/org.openhab.binding.homewizard/ @Daniel-42
171170
/bundles/org.openhab.binding.hpprinter/ @cossey
172171
/bundles/org.openhab.binding.http/ @J-N-K
173-
/bundles/org.openhab.binding.hue/ @cweitkamp @andrewfg
172+
/bundles/org.openhab.binding.hue/ @andrewfg
174173
/bundles/org.openhab.binding.huesync/ @pgfeller
175174
/bundles/org.openhab.binding.hydrawise/ @digitaldan
176175
/bundles/org.openhab.binding.hyperion/ @tavalin
@@ -497,7 +496,7 @@
497496
/itests/org.openhab.binding.astro.tests/ @gerrieg
498497
/itests/org.openhab.binding.avmfritz.tests/ @cweitkamp
499498
/itests/org.openhab.binding.feed.tests/ @openhab/add-ons-maintainers
500-
/itests/org.openhab.binding.hue.tests/ @cweitkamp
499+
/itests/org.openhab.binding.hue.tests/ @openhab/add-ons-maintainers
501500
/itests/org.openhab.binding.max.tests/ @marcelrv
502501
/itests/org.openhab.binding.mielecloud.tests/ @BjoernLange
503502
/itests/org.openhab.binding.modbus.tests/ @ssalonen

CONTRIBUTING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ received feedback on what to improve.
2424
We're trying very hard to keep openHAB lean and focused. We don't want it
2525
to do everything for everybody. This means that we might decide against
2626
incorporating a new feature. However, there might be a way to implement
27-
that feature *on top of* openHAB.
27+
that feature _on top of_ openHAB.
2828

2929
### Discuss your design in the discussion forum
3030

@@ -60,7 +60,7 @@ your documentation changes for clarity, concision, and correctness, as
6060
well as a clean documentation build.
6161

6262
Write clean code. Universally formatted code promotes ease of writing, reading,
63-
and maintenance.
63+
and maintenance.
6464

6565
Pull requests descriptions should be as clear as possible and include a
6666
reference to all the issues that they address.
@@ -88,7 +88,7 @@ pass it on as an open-source patch. The rules are pretty simple: if you
8888
can certify the below (from
8989
[developercertificate.org](https://developercertificate.org/)):
9090

91-
```
91+
```text
9292
Developer Certificate of Origin
9393
Version 1.1
9494
@@ -129,20 +129,22 @@ By making a contribution to this project, I certify that:
129129

130130
then you just add a line to every git commit message:
131131

132-
Signed-off-by: Joe Smith <[email protected]>
132+
```text
133+
Signed-off-by: Joe Smith <[email protected]>
134+
```
133135

134136
using your real name (sorry, no pseudonyms or anonymous contributions.) and an
135137
e-mail address under which you can be reached (sorry, no github noreply e-mail
136-
addresses (such as [email protected]) or other non-reachable
138+
addresses (such as `[email protected]`) or other non-reachable
137139
addresses are allowed).
138140

139141
On the command line you can use `git commit -s` to sign off the commit.
140142

141143
### How can I become a maintainer?
142144

143-
* Step 1: learn the component inside out
144-
* Step 2: make yourself useful by contributing code, bugfixes, support etc.
145-
* Step 3: volunteer on [the discussion group](https://github.com/openhab/openhab-addons/issues?labels=question&page=1&state=open)
145+
- Step 1: learn the component inside out
146+
- Step 2: make yourself useful by contributing code, bugfixes, support etc.
147+
- Step 3: volunteer on [the discussion group](https://github.com/openhab/openhab-addons/issues?labels=question&page=1&state=open)
146148

147149
Don't forget: being a maintainer is a time investment. Make sure you will have time to make yourself available.
148150
You don't have to be a maintainer to make a difference on the project!
@@ -153,22 +155,21 @@ We want to keep the openHAB community awesome, growing and collaborative. We
153155
need your help to keep it that way. To help with this we have come up with some
154156
general guidelines for the community as a whole:
155157

156-
* Be nice: Be courteous, respectful and polite to fellow community members: no
158+
- Be nice: Be courteous, respectful and polite to fellow community members: no
157159
regional, racial, gender, or other abuse will be tolerated. We like nice people
158160
way better than mean ones!
159161

160-
* Encourage diversity and participation: Make everyone in our community
162+
- Encourage diversity and participation: Make everyone in our community
161163
feel welcome, regardless of their background and the extent of their
162164
contributions, and do everything possible to encourage participation in
163165
our community.
164166

165-
* Keep it legal: Basically, don't get us in trouble. Share only content that
167+
- Keep it legal: Basically, don't get us in trouble. Share only content that
166168
you own, do not share private or sensitive information, and don't break the
167169
law.
168170

169-
* Stay on topic: Make sure that you are posting to the correct channel
171+
- Stay on topic: Make sure that you are posting to the correct channel
170172
and avoid off-topic discussions. Remember when you update an issue or
171173
respond to an email you are potentially sending to a large number of
172174
people. Please consider this before you update. Also remember that
173175
nobody likes spam.
174-

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# openHAB Add-ons
22

3-
<img align="right" width="220" src="./logo.png" />
3+
<img align="right" width="220" src="logo.png" alt="openHAB logo" />
44

55
[![GitHub Actions Build Status](https://github.com/openhab/openhab-addons/actions/workflows/ci-build.yml/badge.svg?branch=main)](https://github.com/openhab/openhab-addons/actions/workflows/ci-build.yml)
66
[![Jenkins Build Status](https://ci.openhab.org/job/openHAB-Addons/badge/icon)](https://ci.openhab.org/job/openHAB-Addons/)
@@ -11,18 +11,18 @@ This repository contains the official set of add-ons that are implemented on top
1111
Add-ons that got accepted in here will be maintained (e.g. adapted to new core APIs)
1212
by the [openHAB Add-on maintainers](https://github.com/orgs/openhab/teams/add-ons-maintainers).
1313

14-
To get started with binding development, follow our guidelines and tutorials over at https://www.openhab.org/docs/developer.
14+
To get started with add-on development, follow our guidelines and tutorials over at <https://www.openhab.org/docs/developer>.
1515

16-
If you are interested in openHAB Core development, we invite you to come by on https://github.com/openhab/openhab-core.
16+
If you are interested in openHAB Core development, we invite you to come by on <https://github.com/openhab/openhab-core>.
1717

1818
## Add-ons in other repositories
1919

2020
Some add-ons are not in this repository, but still part of the official [openHAB distribution](https://github.com/openhab/openhab-distro).
2121
An incomplete list of other repositories follows below:
2222

23-
* https://github.com/openhab/org.openhab.binding.zwave
24-
* https://github.com/openhab/org.openhab.binding.zigbee
25-
* https://github.com/openhab/openhab-webui
23+
- <https://github.com/openhab/org.openhab.binding.zwave>
24+
- <https://github.com/openhab/org.openhab.binding.zigbee>
25+
- <https://github.com/openhab/openhab-webui>
2626

2727
## Development / Repository Organization
2828

@@ -33,7 +33,7 @@ The official IDE (Integrated development environment) is Eclipse.
3333

3434
You find the following repository structure:
3535

36-
```
36+
```text
3737
.
3838
+-- bom Maven buildsystem: Bill of materials
3939
| +-- openhab-addons Lists all extensions for other repos to reference them
@@ -76,7 +76,7 @@ mvn clean install -pl :org.openhab.binding.astro
7676

7777
If you have a binding that has dependencies that are dynamically as specified in the feature.xml you can create a `.kar` instead of a `.jar` file.
7878
A `.kar` file will include the feature.xml and when added to openHAB will load and activate any dependencies specified in the feature.xml file.
79-
To create a `.kar` file run maven with the goal `karaf:kar`:
79+
To create a `.kar` file run Maven with the goal `karaf:kar`:
8080

8181
```shell
8282
mvn clean install karaf:kar -pl :org.openhab.binding.astro
@@ -112,7 +112,7 @@ When translations are added or updated and approved in Crowdin, a pull request i
112112
Therefore translations should not be edited in the openHAB-addons repo, but only in Crowdin.
113113
Otherwise translation are overridden by the automatic process.
114114

115-
To fill the English properties file run the following maven command on an add-on:
115+
To fill the English properties file run the following Maven command on an add-on:
116116

117117
```shell
118118
mvn i18n:generate-default-translations
@@ -124,10 +124,9 @@ In some cases the command does not work, and requires the full plug-in name.
124124
In that case use:
125125

126126
```shell
127-
mvn org.openhab.core.tools:i18n-maven-plugin:3.4.0:generate-default-translations
127+
mvn org.openhab.core.tools:i18n-maven-plugin:5.0.0:generate-default-translations
128128
```
129129

130-
131130
#### Code Quality
132131

133132
To check if your code is following the [code style](https://www.openhab.org/docs/developer/guidelines.html#b-code-formatting-rules-style) run:
@@ -136,7 +135,7 @@ To check if your code is following the [code style](https://www.openhab.org/docs
136135
mvn spotless:check
137136
```
138137

139-
To reformat your code so it conforms to the code style you can run:
138+
To reformat your code so it conforms to the code style you can run:
140139

141140
```shell
142141
mvn spotless:apply
@@ -145,7 +144,7 @@ mvn spotless:apply
145144
### Integration Tests
146145

147146
When your add-on also has an integration test in the `itests` directory, you may need to update the runbundles in the `itest.bndrun` file when the Maven dependencies change.
148-
Maven can resolve the integration test dependencies automatically by executing:
147+
Maven can resolve the integration test dependencies automatically by executing:
149148

150149
```shell
151150
mvn clean install -DwithResolver -DskipChecks
@@ -157,6 +156,6 @@ The build generates a `.jar` file per bundle in the respective bundle `/target`
157156

158157
We have assembled some step-by-step guides for different IDEs on our developer documentation website:
159158

160-
https://www.openhab.org/docs/developer/#setup-the-development-environment
159+
<https://www.openhab.org/docs/developer/#setup-the-development-environment>
161160

162161
Happy coding!

bom/openhab-addons/pom.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -651,11 +651,6 @@
651651
<artifactId>org.openhab.binding.freeathome</artifactId>
652652
<version>${project.version}</version>
653653
</dependency>
654-
<dependency>
655-
<groupId>org.openhab.addons.bundles</groupId>
656-
<artifactId>org.openhab.binding.freebox</artifactId>
657-
<version>${project.version}</version>
658-
</dependency>
659654
<dependency>
660655
<groupId>org.openhab.addons.bundles</groupId>
661656
<artifactId>org.openhab.binding.freeboxos</artifactId>

bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/JRubyConsoleCommandExtension.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@
5858
public class JRubyConsoleCommandExtension extends AbstractConsoleCommandExtension implements ConsoleCommandCompleter {
5959
private final Logger logger = LoggerFactory.getLogger(JRubyConsoleCommandExtension.class);
6060

61-
private final String DEFAULT_CONSOLE_PATH = "openhab/console/";
62-
private final String OPENHAB_SCRIPTING_GEM = "gem \"openhab-scripting\", \"~> 5.0\"";
61+
private static final String DEFAULT_CONSOLE_PATH = "openhab/console/";
62+
private static final String OPENHAB_SCRIPTING_GEM = "gem \"openhab-scripting\", \"~> 5.0\"";
6363

6464
private static final String INFO = "info";
6565
private static final String CONSOLE = "console";

0 commit comments

Comments
 (0)