-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
57 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,8 +20,8 @@ | |
"devServerPort": 8081, | ||
"indentation": "Space (4)", | ||
"quotes": "double", | ||
"authorName": "oweitman@gmx.de", | ||
"authorGithub": "oweitman@gmx.de", | ||
"authorName": "oweitman", | ||
"authorGithub": "oweitman", | ||
"authorEmail": "[email protected]", | ||
"gitRemoteProtocol": "HTTPS", | ||
"gitCommit": "no", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,22 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: npm | ||
directory: "/" | ||
schedule: | ||
interval: monthly | ||
time: "04:00" | ||
timezone: Europe/Berlin | ||
open-pull-requests-limit: 5 | ||
assignees: | ||
- oweitman@gmx.de | ||
versioning-strategy: increase | ||
- package-ecosystem: npm | ||
directory: '/' | ||
schedule: | ||
interval: monthly | ||
time: '04:00' | ||
timezone: Europe/Berlin | ||
open-pull-requests-limit: 5 | ||
assignees: | ||
- oweitman | ||
versioning-strategy: increase | ||
|
||
- package-ecosystem: github-actions | ||
directory: "/" | ||
schedule: | ||
interval: monthly | ||
time: "04:00" | ||
timezone: Europe/Berlin | ||
open-pull-requests-limit: 5 | ||
assignees: | ||
- oweitman@gmx.de | ||
- package-ecosystem: github-actions | ||
directory: '/' | ||
schedule: | ||
interval: monthly | ||
time: '04:00' | ||
timezone: Europe/Berlin | ||
open-pull-requests-limit: 5 | ||
assignees: | ||
- oweitman |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
MIT License | ||
|
||
Copyright (c) 2025 oweitman@gmx.de <[email protected]> | ||
Copyright (c) 2025 oweitman <[email protected]> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
 | ||
|
||
# ioBroker.skiinfo | ||
|
||
[](https://www.npmjs.com/package/iobroker.skiinfo) | ||
|
@@ -8,13 +9,14 @@ | |
|
||
[](https://nodei.co/npm/iobroker.skiinfo/) | ||
|
||
**Tests:**  | ||
**Tests:**  | ||
|
||
## skiinfo adapter for ioBroker | ||
|
||
Describe your project here | ||
|
||
## Developer manual | ||
|
||
This section is intended for the developer. It can be deleted later. | ||
|
||
### DISCLAIMER | ||
|
@@ -25,31 +27,35 @@ You can check other adapters for examples or ask in the developer community. Usi | |
### Getting started | ||
|
||
You are almost done, only a few steps left: | ||
|
||
1. Create a new repository on GitHub with the name `ioBroker.skiinfo` | ||
1. Initialize the current folder as a new git repository: | ||
1. Initialize the current folder as a new git repository: | ||
```bash | ||
git init -b main | ||
git add . | ||
git commit -m "Initial commit" | ||
``` | ||
1. Link your local repository with the one on GitHub: | ||
1. Link your local repository with the one on GitHub: | ||
|
||
```bash | ||
git remote add origin https://github.com/oweitman@gmx.de/ioBroker.skiinfo | ||
git remote add origin https://github.com/oweitman/ioBroker.skiinfo | ||
``` | ||
|
||
1. Push all files to the GitHub repo: | ||
1. Push all files to the GitHub repo: | ||
```bash | ||
git push origin main | ||
``` | ||
1. Add a new secret under https://github.com/oweitman@gmx.de/ioBroker.skiinfo/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens. | ||
1. Add a new secret under https://github.com/oweitman/ioBroker.skiinfo/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens. | ||
|
||
1. Head over to [main.js](main.js) and start programming! | ||
|
||
### Best Practices | ||
|
||
We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should | ||
check them out. If you're already experienced, you should also take a look at them - you might learn something new :) | ||
### Scripts in `package.json` | ||
Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>` | ||
| Script name | Description | | ||
|-------------|-------------| | ||
|
@@ -63,35 +69,41 @@ Several npm scripts are predefined for your convenience. You can run them using | |
| `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. | | ||
### Writing tests | ||
When done right, testing code is invaluable, because it gives you the | ||
confidence to change your code while knowing exactly if and when | ||
something breaks. A good read on the topic of test-driven development | ||
is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. | ||
Although writing tests before the code might seem strange at first, but it has very | ||
When done right, testing code is invaluable, because it gives you the | ||
confidence to change your code while knowing exactly if and when | ||
something breaks. A good read on the topic of test-driven development | ||
is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. | ||
Although writing tests before the code might seem strange at first, but it has very | ||
clear upsides. | ||
The template provides you with basic tests for the adapter startup and package files. | ||
It is recommended that you add your own tests into the mix. | ||
### Publishing the adapter | ||
Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form | ||
Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form | ||
`v<major>.<minor>.<patch>`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`. | ||
Since you installed the release script, you can create a new | ||
release simply by calling: | ||
```bash | ||
npm run release | ||
``` | ||
Additional command line options for the release script are explained in the | ||
[release-script documentation](https://github.com/AlCalzone/release-script#command-line). | ||
To get your adapter released in ioBroker, please refer to the documentation | ||
To get your adapter released in ioBroker, please refer to the documentation | ||
of [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository). | ||
### Test the adapter manually with dev-server | ||
Since you set up `dev-server`, you can use it to run, test and debug your adapter. | ||
You may start `dev-server` by calling from your dev directory: | ||
```bash | ||
dev-server watch | ||
``` | ||
|
@@ -101,18 +113,21 @@ The ioBroker.admin interface will then be available at http://localhost:8081/ | |
Please refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details. | ||
## Changelog | ||
<!-- | ||
Placeholder for the next version (at the beginning of the line): | ||
### **WORK IN PROGRESS** | ||
--> | ||
### **WORK IN PROGRESS** | ||
* ([email protected]) initial release | ||
- (oweitman) initial release | ||
## License | ||
MIT License | ||
Copyright (c) 2025 oweitman@gmx.de <[email protected]> | ||
Copyright (c) 2025 oweitman <[email protected]> | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
|
@@ -130,4 +145,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ | |
"name": "oweitman", | ||
"email": "[email protected]" | ||
}, | ||
"homepage": "https://github.com/oweitman@gmx.de/ioBroker.skiinfo", | ||
"homepage": "https://github.com/oweitman/ioBroker.skiinfo", | ||
"license": "MIT", | ||
"keywords": [ | ||
"ioBroker", | ||
|
@@ -16,7 +16,7 @@ | |
], | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/oweitman@gmx.de/ioBroker.skiinfo.git" | ||
"url": "https://github.com/oweitman/ioBroker.skiinfo.git" | ||
}, | ||
"engines": { | ||
"node": ">= 18" | ||
|
@@ -77,7 +77,7 @@ | |
"upload": "NPM_PACK=$(npm pack) && iob url \"$(pwd)/$NPM_PACK\" --debug && rm \"$NPM_PACK\"" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/oweitman@gmx.de/ioBroker.skiinfo/issues" | ||
"url": "https://github.com/oweitman/ioBroker.skiinfo/issues" | ||
}, | ||
"readmeFilename": "README.md" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ | |
version: "0.0.1" | ||
Copyright 2025 oweitman@gmx.de [email protected] | ||
Copyright 2025 oweitman [email protected] | ||
--> | ||
<!-- here you can include so many css as you want --> | ||
<link rel="stylesheet" href="widgets/skiinfo/css/style.css" /> | ||
|