FilesExpand file tree

 master

/

pull-request.yml

Copy path

View Runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

330 lines (302 loc) · 9.62 KB

 master

/

pull-request.yml

Copy path

Top

File metadata and controls

• Code
• Blame

330 lines (302 loc) · 9.62 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

# Run whenever a PR is generated or updated.

# Most jobs check out the code, ensure Python3 is installed, and for build

# tests the ESP8266 toolchain is cached when possible to speed up execution.

name: ESP8266 Arduino CI

on:

pull_request:

permissions:

contents: read

jobs:

# Run 8 parallel jobs for the default build of all examples.

build-linux:

name: Build ${{ matrix.chunk }}

runs-on: ubuntu-latest

defaults:

run:

shell: bash

strategy:

matrix:

chunk: [0, 1, 2, 3, 4, 5, 6, 7]

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Cache Linux toolchain

id: cache-linux

uses: actions/cache@v3

with:

path: ./tools/dist

key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh') }}

- name: Build Sketches

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

BUILD_PARITY: custom

mod: 8

rem: ${{ matrix.chunk }}

run: |

bash ./tests/build.sh

# Cover the debug and IPv6 cases by enabling both and running 8 parallel jobs

# over all example code.

build-debug-ipv6:

name: Debug IPv6 ${{ matrix.chunk }}

runs-on: ubuntu-latest

defaults:

run:

shell: bash

strategy:

matrix:

chunk: [0, 1, 2, 3, 4, 5, 6, 7]

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Cache Linux toolchain

id: cache-linux

uses: actions/cache@v3

with:

path: ./tools/dist

key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh') }}

- name: Build Sketches

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

BUILD_PARITY: custom

mod: 8

rem: ${{ matrix.chunk }}

run: |

bash ./tests/debug6.sh

# Single build under Windows to ensure the Win toolchain is good.

build-windows:

name: Windows

runs-on: windows-latest

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Cache Windows toolchain

id: cache-windows

uses: actions/cache@v3

with:

path: ./tools/dist

key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh') }}

- name: Build Sketch

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

WINDOWS: 1

BUILD_PARITY: custom

mod: 500

rem: 1

run: |

# Windows has python3 already installed, but it's called "python".

# Copy python.exe to the proper name so scripts "just work".

try { Get-Command python3 } catch { copy (get-command python).source (get-command python).source.Replace("python.exe", "python3.exe") }

bash ./tests/build.sh

# Single build under macOS to ensure the Mac toolchain is good.

build-mac:

name: Mac

runs-on: macOS-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Cache Mac toolchain

id: cache-mac

uses: actions/cache@v3

with:

path: ./tools/dist

key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh') }}

- name: Build Sketch

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

MACOSX: 1

BUILD_PARITY: custom

mod: 500

rem: 1

run: |

bash ./tests/build.sh

# Run a few Platform.IO jobs (not full suite) to check PIO integration.

build-pio:

name: Build Platform.IO

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Build subset on Platform.IO

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

BUILD_PARITY: custom

mod: 42 # Picked at random to give 4-5 builds and exit.

rem: 13

run: |

sudo apt update

sudo apt install python3-pip python3-setuptools

PATH=/home/runner/.local/bin:$PATH bash ./tests/platformio.sh

# Run host test suite under valgrind for runtime checking of code.

host-tests:

name: Host tests

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Run host tests

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

run: |

sudo apt update

sudo apt install valgrind lcov

bash ./tests/ci/host_test.sh

# Ensure Sphinx can build the documentation properly.

documentation:

name: Documentation

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Build documentation

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

run: |

sudo apt update

sudo apt install python3-pip python3-setuptools

# GitHub CI installs pip3 and setuptools outside the path.

# Update the path to include them and run.

PATH=/home/runner/.local/bin:$PATH pip3 install --user -r doc/requirements.txt

PATH=/home/runner/.local/bin:$PATH bash ./tests/ci/build_docs.sh

# Standard Arduino formatting in all the examples

style-check:

name: Style and formatting

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Style check

env:

LLVM_SNAPSHOT_KEY: "6084F3CF814B57C1CF12EFD515CF4D18AF4F7421"

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

run: |

export GNUPGHOME=$(mktemp -d)

gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$LLVM_SNAPSHOT_KEY"

gpg --batch --armor --export "$LLVM_SNAPSHOT_KEY" | \

sudo tee /etc/apt/trusted.gpg.d/llvm-snapshot.gpg.asc

gpgconf --kill all

rm -r $GNUPGHOME

echo "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-13 main" | \

sudo tee /etc/apt/sources.list.d/llvm.list

sudo apt update

sudo apt install clang-format-13

pip3 install pyyaml

bash ./tests/ci/style_check.sh

# Quick test that the mocking builds succeed

mock-check:

name: Mock trivial test

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Mock build

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

run: |

bash ./tests/buildm.sh

# Ensure no manual edits to boards.txt

boards-check:

name: Boards.txt check

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- uses: actions/setup-python@v4

with:

python-version: '3.x'

- name: Cache Linux toolchain

id: cache-linux

uses: actions/cache@v3

with:

path: ./tools/dist

key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh') }}

- name: Boards.txt diff

env:

TRAVIS_BUILD_DIR: ${{ github.workspace }}

TRAVIS_TAG: ${{ github.ref }}

run: |

bash ./tests/ci/build_boards.sh

bash ./tests/ci/eboot_test.sh

bash ./tests/ci/pkgrefs_test.sh

# Validate orthography

code-spell:

name: Check spelling

runs-on: ubuntu-latest

defaults:

run:

shell: bash

steps:

- uses: actions/checkout@v3

with:

submodules: true

- name: Run codespell

uses: codespell-project/actions-codespell@master

with:

skip: ./libraries/ESP8266SdFat,./libraries/LittleFS/lib,./tools/pyserial,./tools/sdk,./tools/esptool,./libraries/SoftwareSerial,./libraries/Ethernet,./github/workflows,./libraries/ESP8266HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino,./libraries/esp8266/examples/RTCUserMemory/RTCUserMemory.ino,./libraries/esp8266/examples/StreamString/StreamString.ino,./libraries/ESP8266WiFi/examples/BearSSL_Validation/BearSSL_Validation.ino,./libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino,./libraries/ESP8266WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino,./libraries/ESP8266WebServer/examples/HttpHashCredAuth/HttpHashCredAuth.ino,./cores/esp8266/spiffs,./tests/device/test_libc/libm_string.c, ./libraries/Netdump/examples/Netdump/Netdump.ino,./libraries/ESP8266WiFi/examples/BearSSL_Server,./cores/esp8266/LwipIntfDev.h

ignore_words_list: ESP8266,esp8266,esp,dout,DOUT,ser,ans