Skip to content

Commit ca1a6d4

Browse files
GOB52GOB52
committed
Add workflows and ISSUE_TEMPLATE
1 parent 0e7df96 commit ca1a6d4

8 files changed

Lines changed: 656 additions & 0 deletions

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Source:
2+
# https://github.com/Tinyu-Zhao/M5-Depends/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml
3+
# See:
4+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
5+
6+
name: Bug report
7+
description: Report a problem with the code in this repository.
8+
labels:
9+
- "type: bug"
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: "Thank you for opening an issue on an M5Stack Arduino library repository.\n\
14+
To improve the speed of resolution please review the following guidelines and common troubleshooting steps below before creating the issue:\n\
15+
If you have any UIFLOW questions you can ask in the [special board](https://community.m5stack.com/category/5/uiflow), there will be many enthusiastic friends to help you.\n\
16+
Do not use GitHub issues for troubleshooting projects and issues. Instead use the forums at https://community.m5stack.com to ask questions and troubleshoot why something isn't working as expected. In many cases the problem is a common issue that you will more quickly receive help from the forum community. GitHub issues are meant for known defects in the code. If you don't know if there is a defect in the code then start with troubleshooting on the forum first."
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Describe the bug
21+
description: A clear and concise description of what the bug is.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: reproduce
26+
attributes:
27+
label: To reproduce
28+
description: Provide the specific set of steps we can follow to reproduce the problem.
29+
placeholder: |
30+
1. In this environment...
31+
2. With this config...
32+
3. Run '...'
33+
4. See error...
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: expected
38+
attributes:
39+
label: Expected behavior
40+
description: What would you expect to happen after following those instructions?
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: screenshots
45+
attributes:
46+
label: Screenshots
47+
description: If applicable, add screenshots to help explain your problem.
48+
validations:
49+
required: false
50+
- type: textarea
51+
id: information
52+
attributes:
53+
label: Environment
54+
description: |
55+
If applicable, add screenshots to help explain your problem.
56+
examples:
57+
- **OS**: Ubuntu 20.04
58+
- **IDE & IDE Version**: Arduino 1.8.19 Or Platform IO v2.5.0
59+
- **Repository Version**: 0.4.0
60+
value: |
61+
- OS:
62+
- IDE &IDE Version:
63+
- Repository Version:
64+
validations:
65+
required: false
66+
- type: textarea
67+
id: additional
68+
attributes:
69+
label: Additional context
70+
description: Add any additional information here.
71+
validations:
72+
required: false
73+
- type: checkboxes
74+
id: checklist
75+
attributes:
76+
label: Issue checklist
77+
description: Please double-check that you have done each of the following things before submitting the issue.
78+
options:
79+
- label: I searched for previous reports in [the issue tracker](https://github.com/m5stack/M5Unit-RTC/issues?q=)
80+
required: true
81+
- label: My report contains all necessary details
82+
required: true

‎.github/workflows/Arduino-Lint-Check.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Arduino Lint Check
2+
on:
3+
push:
4+
branches: [ master, main ]
5+
pull_request:
6+
branches: [ master, main ]
7+
workflow_dispatch:
8+
9+
defaults:
10+
run:
11+
shell: bash
12+
13+
concurrency:
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
cancel-in-progress: true
16+
17+
jobs:
18+
lint:
19+
name: Lint Check
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: arduino/arduino-lint-action@v2
24+
with:
25+
library-manager: update
26+
compliance: strict
27+
project-type: all

‎.github/workflows/arduino-esp-v2-build-check.yml‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Build(arduino-esp32:2.x)
2+
3+
env:
4+
SKETCH_NAMES_FIND_START: ./examples/UnitUnified
5+
REQUIRED_LIBRARIES: M5Unified,M5UnitUnified
6+
7+
on:
8+
push:
9+
tags-ignore:
10+
- '*.*.*'
11+
- 'v*.*.*'
12+
branches:
13+
- '*'
14+
paths:
15+
- 'src/unit/**.cpp'
16+
- 'src/unit/**.hpp'
17+
- 'src/unit/**.h'
18+
- 'src/unit/**.c'
19+
- 'examples/UnitUnified/**.ino'
20+
- 'examples/UnitUnified/**.cpp'
21+
- 'examples/UnitUnified/**.hpp'
22+
- 'examples/UnitUnified/**.h'
23+
- 'examples/UnitUnified/**.c'
24+
- '**arduino-esp-v2-build-check.yml'
25+
pull_request:
26+
paths:
27+
- 'src/unit/**.cpp'
28+
- 'src/unit/**.hpp'
29+
- 'src/unit/**.h'
30+
- 'src/unit/**.c'
31+
- 'examples/UnitUnified/**.ino'
32+
- 'examples/UnitUnified/**.cpp'
33+
- 'examples/UnitUnified/**.hpp'
34+
- 'examples/UnitUnified/**.h'
35+
- 'examples/UnitUnified/**.c'
36+
- '**arduino-esp-v2-build-check.yml'
37+
workflow_dispatch:
38+
39+
defaults:
40+
run:
41+
shell: bash
42+
43+
concurrency:
44+
group: ${{ github.workflow }}-${{ github.ref }}
45+
cancel-in-progress: true
46+
47+
jobs:
48+
build:
49+
name: ${{ matrix.sketch }}:${{matrix.board}}@${{matrix.platform-version}}
50+
runs-on: ubuntu-latest
51+
timeout-minutes: 12
52+
53+
strategy:
54+
fail-fast: false
55+
max-parallel: 20
56+
matrix:
57+
platform-url:
58+
- https://espressif.github.io/arduino-esp32/package_esp32_index.json
59+
60+
sketch:
61+
- PlotToSerial
62+
63+
board:
64+
- m5stack-atom
65+
- m5stack-atoms3
66+
- m5stack-core-esp32
67+
- m5stack-core2
68+
- m5stack-coreink
69+
- m5stack-cores3
70+
- m5stack-fire
71+
72+
platform-version:
73+
- 2.0.17
74+
75+
platform:
76+
- esp32
77+
78+
archi:
79+
- esp32
80+
81+
include:
82+
- sketch: AlarmNotify
83+
platform-url: https://espressif.github.io/arduino-esp32/package_esp32_index.json
84+
platform: esp32
85+
archi: esp32
86+
platform-version: 2.0.17
87+
board: m5stack-core-esp32
88+
- sketch: PeriodicTimer
89+
platform-url: https://espressif.github.io/arduino-esp32/package_esp32_index.json
90+
platform: esp32
91+
archi: esp32
92+
platform-version: 2.0.17
93+
board: m5stack-core-esp32
94+
95+
steps:
96+
- name: Checkout
97+
uses: actions/checkout@v4
98+
99+
# Build
100+
- name: Compile examples
101+
uses: ArminJo/arduino-test-compile@master
102+
with:
103+
arduino-board-fqbn: ${{ matrix.platform }}:${{ matrix.archi }}:${{ matrix.board }}
104+
arduino-platform: ${{ matrix.platform }}:${{ matrix.archi }}@${{ matrix.platform-version }}
105+
platform-url: ${{ matrix.platform-url }}
106+
required-libraries: ${{ env.REQUIRED_LIBRARIES }}
107+
extra-arduino-cli-args: ${{ matrix.cli-args }}
108+
sketch-names: ${{ matrix.sketch }}.ino
109+
sketch-names-find-start: ${{ env.SKETCH_NAMES_FIND_START }}/

‎.github/workflows/arduino-esp-v3-build-check.yml‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
name: Build(arduino-esp32:3.x)
2+
3+
env:
4+
SKETCH_NAMES_FIND_START: ./examples/UnitUnified
5+
REQUIRED_LIBRARIES: M5Unified,M5UnitUnified
6+
7+
on:
8+
push:
9+
tags-ignore:
10+
- '*.*.*'
11+
- 'v*.*.*'
12+
branches:
13+
- '*'
14+
paths:
15+
- 'src/unit/**.cpp'
16+
- 'src/unit/**.hpp'
17+
- 'src/unit/**.h'
18+
- 'src/unit/**.c'
19+
- 'examples/UnitUnified/**.ino'
20+
- 'examples/UnitUnified/**.cpp'
21+
- 'examples/UnitUnified/**.hpp'
22+
- 'examples/UnitUnified/**.h'
23+
- 'examples/UnitUnified/**.c'
24+
- '**arduino-esp-v3-build-check.yml'
25+
pull_request:
26+
paths:
27+
- 'src/unit/**.cpp'
28+
- 'src/unit/**.hpp'
29+
- 'src/unit/**.h'
30+
- 'src/unit/**.c'
31+
- 'examples/UnitUnified/**.ino'
32+
- 'examples/UnitUnified/**.cpp'
33+
- 'examples/UnitUnified/**.hpp'
34+
- 'examples/UnitUnified/**.h'
35+
- 'examples/UnitUnified/**.c'
36+
- '**arduino-esp-v3-build-check.yml'
37+
workflow_dispatch:
38+
39+
defaults:
40+
run:
41+
shell: bash
42+
43+
concurrency:
44+
group: ${{ github.workflow }}-${{ github.ref }}
45+
cancel-in-progress: true
46+
47+
jobs:
48+
build:
49+
name: ${{ matrix.sketch }}:${{matrix.board}}@${{matrix.platform-version}}
50+
runs-on: ubuntu-latest
51+
timeout-minutes: 12
52+
53+
strategy:
54+
fail-fast: false
55+
max-parallel: 20
56+
matrix:
57+
platform-url:
58+
- https://espressif.github.io/arduino-esp32/package_esp32_index.json
59+
60+
sketch:
61+
- PlotToSerial
62+
63+
board:
64+
- arduino_nesso_n1
65+
- m5stack_atom
66+
- m5stack_atoms3
67+
- m5stack_capsule
68+
- m5stack_cardputer
69+
- m5stack_core
70+
- m5stack_core2
71+
- m5stack_coreink
72+
- m5stack_cores3
73+
- m5stack_dial
74+
- m5stack_dinmeter
75+
- m5stack_fire
76+
- m5stack_nanoc6
77+
- m5stack_paper
78+
- m5stack_stamp_s3
79+
- m5stack_stickc_plus
80+
- m5stack_stickc_plus2
81+
- m5stack_tab5
82+
83+
platform-version:
84+
- 3.3.6
85+
86+
platform:
87+
- esp32
88+
89+
archi:
90+
- esp32
91+
92+
include:
93+
- sketch: AlarmNotify
94+
platform-url: https://espressif.github.io/arduino-esp32/package_esp32_index.json
95+
platform: esp32
96+
archi: esp32
97+
platform-version: 3.3.6
98+
board: m5stack_core
99+
- sketch: PeriodicTimer
100+
platform-url: https://espressif.github.io/arduino-esp32/package_esp32_index.json
101+
platform: esp32
102+
archi: esp32
103+
platform-version: 3.3.6
104+
board: m5stack_core
105+
106+
steps:
107+
- name: Checkout
108+
uses: actions/checkout@v4
109+
110+
# Build
111+
- name: Compile examples
112+
uses: ArminJo/arduino-test-compile@master
113+
with:
114+
arduino-board-fqbn: ${{ matrix.platform }}:${{ matrix.archi }}:${{ matrix.board }}
115+
arduino-platform: ${{ matrix.platform }}:${{ matrix.archi }}@${{ matrix.platform-version }}
116+
platform-url: ${{ matrix.platform-url }}
117+
required-libraries: ${{ env.REQUIRED_LIBRARIES }}
118+
extra-arduino-cli-args: ${{ matrix.cli-args }}
119+
sketch-names: ${{ matrix.sketch }}.ino
120+
sketch-names-find-start: ${{ env.SKETCH_NAMES_FIND_START }}/

0 commit comments

Comments
 (0)