Skip to content

Commit cac422c

Browse files
committed
doc: upload
1 parent 9d7a762 commit cac422c

7 files changed

Lines changed: 360 additions & 0 deletions

File tree

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
name: Bug report
2+
description: Something is not working as it should
3+
title: "[Bug]: "
4+
labels: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**Thank you for wanting to report a bug in this adapter!**
10+
11+
12+
If this is the first time you are doing this, please take a few moments to read
13+
through the adapter documentation.
14+
15+
16+
You are about to report a bug in this adapter. Do not proceed if your issue
17+
occurs with ioBroker core, any third party adapters, unofficial or outdated
18+
adapter versions.
19+
20+
21+
Do also not seek support here ("I need help with ...", "I have a
22+
question ...", "Can someone walk me through ..."), that belongs into the
23+
[ioBroker forum at forum.iobroker.net](https://forum.iobroker.net/).
24+
25+
26+
And finally, make sure any bug you want to report is still present with the **current**
27+
adapter version.
28+
29+
30+
Thank you for your collaboration!
31+
32+
- type: textarea
33+
id: bug-description
34+
attributes:
35+
label: Describe the bug
36+
description: A clear and concise description of what the bug is.
37+
placeholder: Tell us what you see and what you expected to see.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: reproduce
43+
attributes:
44+
label: To Reproduce
45+
description: Steps to reproduce the behavior
46+
placeholder: |
47+
1. Go to '...'
48+
2. Click on '...'
49+
3. Scroll down to '....'
50+
4. See error
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: expected-behavior
56+
attributes:
57+
label: Expected behavior
58+
description: A clear and concise description of what you expected to happen.
59+
validations:
60+
required: true
61+
62+
- type: markdown
63+
attributes:
64+
value: |
65+
## Environment
66+
67+
- type: input
68+
id: adapter-version
69+
attributes:
70+
label: Adapter version
71+
description: Can be found in the adapters tab of ioBroker admin
72+
placeholder: e.g., 1.2.3
73+
validations:
74+
required: true
75+
76+
- type: input
77+
id: js-controller-version
78+
attributes:
79+
label: JS-Controller version
80+
description: Can be found in the host section of ioBroker admin (or use `iobroker -v` on the console)
81+
placeholder: e.g., 5.0.19
82+
validations:
83+
required: true
84+
85+
- type: input
86+
id: node-version
87+
attributes:
88+
label: Node version
89+
description: Determine this with `node -v` on the console
90+
placeholder: e.g., v18.19.0
91+
validations:
92+
required: true
93+
94+
- type: input
95+
id: operating-system
96+
attributes:
97+
label: Operating system
98+
description: Which OS are you running ioBroker on?
99+
placeholder: e.g., Linux, Windows 10, Raspberry Pi OS
100+
validations:
101+
required: true
102+
103+
- type: markdown
104+
attributes:
105+
value: |
106+
## Logs and other files needed for analysis
107+
108+
- type: checkboxes
109+
id: log-files
110+
attributes:
111+
label: Checklist of files to include in report
112+
options:
113+
- label: Adapter log file (Please share the logs in debug mode if possible)
114+
- label: Screenshots (if applicable to help explain the problem)
115+
116+
- type: textarea
117+
id: additional-logs
118+
attributes:
119+
label: Additional log files and screenshots
120+
description: |
121+
Please provide relevant logs and screenshots here.
122+
For logs, enable debug mode for the adapter if possible.
123+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
124+
125+
- type: textarea
126+
id: additional-context
127+
attributes:
128+
label: Additional context
129+
description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ioBroker Community
4+
url: https://forum.iobroker.net/
5+
about: Please ask and answer questions here.
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Feature request
2+
description: Suggest an idea for this adapter
3+
title: "[Feature Request]: "
4+
labels: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**Thank you for wanting to suggest a feature for this adapter!**
10+
11+
12+
Please note that feature requests should be about new functionality or improvements
13+
to the adapter itself.
14+
15+
16+
Before submitting, please check if:
17+
18+
- The feature already exists in the latest version
19+
20+
- There is already an open issue for this feature
21+
22+
- This is about the adapter and not about ioBroker core functionality
23+
24+
25+
For general questions or support, please use the
26+
[ioBroker forum at forum.iobroker.net](https://forum.iobroker.net/).
27+
28+
29+
Thank you for your collaboration!
30+
31+
- type: textarea
32+
id: problem-description
33+
attributes:
34+
label: Is your feature request related to a problem?
35+
description: A clear and concise description of what the problem is.
36+
placeholder: "I'm always frustrated when ..."
37+
validations:
38+
required: false
39+
40+
- type: textarea
41+
id: proposed-solution
42+
attributes:
43+
label: Describe the solution you'd like
44+
description: A clear and concise description of what you want to happen.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: alternatives
50+
attributes:
51+
label: Describe alternatives you've considered
52+
description: A clear and concise description of any alternative solutions or features you've considered.
53+
validations:
54+
required: false
55+
56+
- type: textarea
57+
id: additional-context
58+
attributes:
59+
label: Additional context
60+
description: Add any other context, screenshots, or examples about the feature request here.
61+
validations:
62+
required: false

.github/auto-merge.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Configure here which dependency updates should be merged automatically.
2+
# The recommended configuration is the following:
3+
- match:
4+
# Only merge patches for production dependencies
5+
dependency_type: production
6+
update_type: "semver:patch"
7+
- match:
8+
# Except for security fixes, here we allow minor patches
9+
dependency_type: production
10+
update_type: "security:minor"
11+
- match:
12+
# and development dependencies can have a minor update, too
13+
dependency_type: development
14+
update_type: "semver:minor"
15+
16+
# The syntax is based on the legacy dependabot v1 automerged_updates syntax, see:
17+
# https://dependabot.com/docs/config-file/#automerged_updates

.github/dependabot.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: "/"
5+
schedule:
6+
interval: monthly
7+
day: 5
8+
time: "00:05"
9+
timezone: Europe/Berlin
10+
open-pull-requests-limit: 5
11+
assignees:
12+
- H5N1v2
13+
versioning-strategy: increase
14+
15+
- package-ecosystem: github-actions
16+
directory: "/"
17+
schedule:
18+
interval: monthly
19+
day: 5
20+
time: "00:05"
21+
timezone: Europe/Berlin
22+
open-pull-requests-limit: 5
23+
assignees:
24+
- H5N1v2
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Automatically merge Dependabot PRs when version comparison is within the range
2+
# that is configured in .github/auto-merge.yml
3+
4+
name: Auto-Merge Dependabot PRs
5+
6+
on:
7+
# WARNING: This needs to be run in the PR base, DO NOT build untrusted code in this action
8+
# details under https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/
9+
pull_request_target:
10+
11+
jobs:
12+
auto-merge:
13+
if: github.actor == 'dependabot[bot]'
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Check if PR should be auto-merged
20+
uses: ahmadnassri/action-dependabot-auto-merge@v2
21+
with:
22+
# In order to use this, you need to go to https://github.com/settings/tokens and
23+
# create a Personal Access Token with the permission "public_repo".
24+
# Enter this token in your repository settings under "Secrets" and name it AUTO_MERGE_TOKEN
25+
github-token: ${{ secrets.AUTO_MERGE_TOKEN }}
26+
# By default, squash and merge, so Github chooses nice commit messages
27+
command: squash and merge
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Test and Release
2+
3+
# Run this job on all pushes and pull requests
4+
# as well as tags with a semantic version
5+
on:
6+
push:
7+
branches:
8+
- "main"
9+
tags:
10+
# normal versions
11+
- "v[0-9]+.[0-9]+.[0-9]+"
12+
# pre-releases
13+
- "v[0-9]+.[0-9]+.[0-9]+-**"
14+
pull_request: {}
15+
16+
# Cancel previous PR/branch runs when a new commit is pushed
17+
concurrency:
18+
group: ${{ github.ref }}
19+
cancel-in-progress: true
20+
21+
jobs:
22+
# Performs quick checks before the expensive test runs
23+
check-and-lint:
24+
if: contains(github.event.head_commit.message, '[skip ci]') == false
25+
26+
runs-on: ubuntu-latest
27+
28+
steps:
29+
- uses: ioBroker/testing-action-check@v1
30+
with:
31+
node-version: '20.x'
32+
# Uncomment the following line if your adapter cannot be installed using 'npm ci'
33+
# install-command: 'npm install'
34+
type-checking: true
35+
lint: true
36+
37+
# Runs adapter tests on all supported node versions and OSes
38+
adapter-tests:
39+
if: contains(github.event.head_commit.message, '[skip ci]') == false
40+
41+
runs-on: ${{ matrix.os }}
42+
strategy:
43+
matrix:
44+
node-version: [20.x, 22.x, 24.x]
45+
os: [ubuntu-latest, windows-latest, macos-latest]
46+
47+
steps:
48+
- uses: ioBroker/testing-action-adapter@v1
49+
with:
50+
node-version: ${{ matrix.node-version }}
51+
os: ${{ matrix.os }}
52+
# Uncomment the following line if your adapter cannot be installed using 'npm ci'
53+
# install-command: 'npm install'
54+
build: true
55+
56+
# TODO: To enable automatic npm releases, set up trusted publishing in your npm account
57+
# See https://docs.npmjs.com/trusted-publishers for more details
58+
# Then uncomment the following block:
59+
60+
# # Deploys the final package to NPM
61+
# deploy:
62+
# needs: [check-and-lint, adapter-tests]
63+
#
64+
# # Trigger this step only when a commit on any branch is tagged with a version number
65+
# if: |
66+
# contains(github.event.head_commit.message, '[skip ci]') == false &&
67+
# github.event_name == 'push' &&
68+
# startsWith(github.ref, 'refs/tags/v')
69+
#
70+
# runs-on: ubuntu-latest
71+
#
72+
# # Write permissions are required to create Github releases
73+
# permissions:
74+
# id-token: write
75+
# contents: write
76+
#
77+
# steps:
78+
# - uses: ioBroker/testing-action-deploy@v1
79+
# with:
80+
# node-version: '20.x'
81+
# # Uncomment the following line if your adapter cannot be installed using 'npm ci'
82+
# # install-command: 'npm install'
83+
# build: true
84+
# github-token: ${{ secrets.GITHUB_TOKEN }}
85+
#
86+
# # When using Sentry for error reporting, Sentry can be informed about new releases
87+
# # To enable create a API-Token in Sentry (User settings, API keys)
88+
# # Enter this token as a GitHub secret (with name SENTRY_AUTH_TOKEN) in the repository options
89+
# # Then uncomment and customize the following block:
90+
# sentry: true
91+
# sentry-token: ${{ secrets.SENTRY_AUTH_TOKEN }}
92+
# sentry-project: "iobroker-nextcloud_monitoring"
93+
# sentry-version-prefix: "iobroker.nextcloud_monitoring"
94+
# sentry-sourcemap-paths: "build/"
95+
# # If your sentry project is linked to a GitHub repository, you can enable the following option
96+
# # sentry-github-integration: true

0 commit comments

Comments
 (0)