Skip to content
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

Commit 339e91e

Browse files
authored
Update .github
1 parent 8a00389 commit 339e91e

File tree

6 files changed

+114
-10
lines changed

6 files changed

+114
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+37-9
Original file line numberDiff line numberDiff line change
@@ -35,24 +35,26 @@ If applicable, add screenshots to help explain your problem.
3535

3636
Please ensure to specify the following:
3737

38-
* Arduino IDE version (e.g. 1.8.13) or Platform.io version
39-
* `ESP8266`,`ESP32` or `STM32` Core Version (e.g. ESP8266 core v2.7.4, ESP32 v1.0.5 or STM32 v1.9.0)
38+
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
39+
* `ESP8266` Core Version (e.g. ESP8266 core v3.0.2)
4040
* Contextual information (e.g. what you were trying to achieve)
4141
* Simplest possible steps to reproduce
4242
* Anything that might be relevant in your opinion, such as:
4343
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
4444
* Network configuration
45-
45+
46+
4647
### Example
4748

4849
```
49-
Arduino IDE version: 1.8.13
50-
ESP32 Core Version 1.0.5
50+
Arduino IDE version: v1.8.19
51+
ESP8266 Core Version v3.0.2
52+
ESP8266_NODEMCU
5153
OS: Ubuntu 20.04 LTS
52-
Linux xy-Inspiron-3593 5.4.0-66-generic #74-Ubuntu SMP Wed Jan 27 22:54:38 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
54+
Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
5355
5456
Context:
55-
I encountered an endless loop while trying to connect to Local WiFi.
57+
I encountered a crash while trying to use the library
5658
5759
Steps to reproduce:
5860
1. ...
@@ -61,6 +63,32 @@ Steps to reproduce:
6163
4. ...
6264
```
6365

64-
### Additional context
66+
---
67+
68+
### Sending Feature Requests
69+
70+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
71+
72+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP8266TimerInterrupt/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
73+
74+
---
75+
76+
### Sending Pull Requests
77+
78+
Pull Requests with changes and fixes are also welcome!
79+
80+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
81+
82+
1. Change directory to the library GitHub
83+
84+
```
85+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP8266TimerInterrupt_GitHub/
86+
xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266TimerInterrupt_GitHub$
87+
```
88+
89+
2. Issue astyle command
90+
91+
```
92+
xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266TimerInterrupt_GitHub$ bash utils/restyle.sh
93+
```
6594

66-
Add any other context about the problem here.

.github/dependabot.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file
2+
version: 2
3+
4+
updates:
5+
# Configure check for outdated GitHub Actions actions in workflows.
6+
# See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
7+
- package-ecosystem: github-actions
8+
directory: / # Check the repository's workflows under /.github/workflows/
9+
schedule:
10+
interval: daily

.github/workflows/auto-github-actions.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ jobs:
55
runs-on: ubuntu-latest
66
steps:
77
- uses: actions/checkout@v2
8-
- uses: actions/setup-node@v2
8+
- uses: actions/setup-node@v3
99
with:
1010
node-version: '14'
1111
- run: npm install -g bats

.github/workflows/check-arduino.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Check Arduino
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v2
20+
21+
- name: Arduino Lint
22+
uses: arduino/arduino-lint-action@v1
23+
with:
24+
compliance: specification
25+
library-manager: update
26+
# Always use this setting for official repositories. Remove for 3rd party projects.
27+
official: true
28+
project-type: library
+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Report Size Deltas
2+
3+
on:
4+
schedule:
5+
- cron: '*/5 * * * *'
6+
7+
jobs:
8+
report:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Comment size deltas reports to PRs
13+
uses: arduino/report-size-deltas@v1
14+
with:
15+
# The name of the workflow artifact created by the "Compile Examples" workflow
16+
sketches-reports-source: sketches-reports

.github/workflows/spell-check.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Spell Check
2+
3+
on:
4+
pull_request:
5+
push:
6+
schedule:
7+
# run every Tuesday at 3 AM UTC
8+
- cron: "0 3 * * 2"
9+
workflow_dispatch:
10+
repository_dispatch:
11+
12+
jobs:
13+
spellcheck:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v2
19+
20+
# See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
21+
- name: Spell check
22+
uses: codespell-project/actions-codespell@master

0 commit comments

Comments
 (0)