Skip to content

Commit

Permalink
Add linter to automatically validate changes (Koenkk#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjb authored Apr 10, 2022
1 parent 47d0495 commit f51ed04
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# This workflow executes several linters on changed files based on languages used in your code base whenever
# you push a code or open a pull request.
#
# You can adjust the behavior by modifying this file.
# For more information, see:
# https://github.com/github/super-linter
name: Lint Code Base

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
run-lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
# Full git history is needed to get a proper list of changed files within `super-linter`
fetch-depth: 0

- name: Lint Code Base
uses: github/super-linter@v4
env:
VALIDATE_ALL_CODEBASE: false
FILTER_REGEX_EXCLUDE: .*images/.*
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# zigbee-OTA

[![Lint Code Base status badge](https://github.com/Koenkk/zigbee-OTA/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/Koenkk/zigbee-OTA/actions/workflows/linter.yml)

A collection of Zigbee OTA files, see `index.json` for an overview of all available firmware files.

## Adding new and updating existing OTA files

1. Go to this directory
2. Execute `node scripts/add.js PATH_TO_OTA_FILE_OR_URL`, e.g.:
- `node scripts/add.js ~/Downloads/WhiteLamp-Atmel-Target_0105_5.130.1.30000_0012.sbl-ota`
- `node scripts/add.js http://fds.dc1.philips.com/firmware/ZGB_100B_010D/1107323831/Sensor-ATmega_6.1.1.27575_0012.sbl-ota`
3. Create a PR
3. Create a PR. Changes will be automatically validated by GitHub.

## Updating all existing OTA entries (if `add.js` has been changed)

## Updating all existing OTA entries (if add.js has been changed)
1. Go to this directory
2. Execute `node scripts/updateall.js`
3. Create a PR
3. Create a PR. Changes will be automatically validated by GitHub.

0 comments on commit f51ed04

Please sign in to comment.