From 0b4f8cc8b7b5c0f9c803beb14cb6c996bde80dc4 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Wed, 7 Jul 2021 16:56:21 +1000 Subject: [PATCH 01/18] Don't run unit tests under Travis. These are being run as GitHub actions. Reduce stuff running on Travis For #1522 --- .github/workflows/UnitTests.yml | 2 +- .travis.yml | 9 +-------- 2 files changed, 2 insertions(+), 9 deletions(-) diff --git a/.github/workflows/UnitTests.yml b/.github/workflows/UnitTests.yml index 0245bdb34..6fe3fa055 100644 --- a/.github/workflows/UnitTests.yml +++ b/.github/workflows/UnitTests.yml @@ -18,4 +18,4 @@ jobs: - name: Build and run the library unit tests. run: (cd test; make run) - name: Build and run the tools unit tests. - run: (cd tools; make run_tests) + run: (cd tools; make all; make run_tests) diff --git a/.travis.yml b/.travis.yml index 0b8bf6e16..e606ad056 100644 --- a/.travis.yml +++ b/.travis.yml @@ -41,7 +41,7 @@ jobs: # Check that IRrecvDumpV2+ compiles. # i.e. We are splitting the work load in to parallel tasks. - find . -regextype egrep -name platformio.ini -type f -regex "${IRRECVDUMP_RE}" | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir - - name: "Unit tests, Linter, Doc checks, & Compile IRMQTTServer" + - name: "Linter, Doc checks, & Compile IRMQTTServer" script: # Run all the Tests & check the code linters have no issues, and that # IRMQTTServer compiles. @@ -50,18 +50,11 @@ jobs: - LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) - test ${LIB_VERSION} == "$(jq -r .version library.json)" - grep -q "^version=${LIB_VERSION}$" library.properties - # Check the tools programs compile. - - (cd tools; make all) # Check for lint issues. - shopt -s nullglob - python cpplint.py --extensions=c,cc,cpp,ino --headers=h,hpp {src,src/locale,test,tools}/*.{h,c,cc,cpp,hpp,ino} examples/*/*.{h,c,cc,cpp,hpp,ino} - pylint3 -d F0001 {src,test,tools}/*.py - shopt -u nullglob - # Install the Google test suite. - - (cd test; make install-googletest) - # Build and run the unit tests. - - (cd test; make run) - - (cd tools; make run_tests) # Check that every example directory has a platformio.ini file. - (status=0; for dir in examples/*; do if [[ ! -f "${dir}/platformio.ini" ]]; then echo "${dir} has no 'platform.ini' file!"; status=1; fi; done; exit ${status}) # Check that doxygen completes without errors or warnings. From e3397d55d43b62e35ecaf9fc12ec3ec439b8c8c6 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Wed, 7 Jul 2021 17:24:41 +1000 Subject: [PATCH 02/18] Attempt to build some examples using Github Actions & PlatformIO --- .github/workflows/PlatformIO.yml | 38 ++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/PlatformIO.yml diff --git a/.github/workflows/PlatformIO.yml b/.github/workflows/PlatformIO.yml new file mode 100644 index 000000000..db71ebea7 --- /dev/null +++ b/.github/workflows/PlatformIO.yml @@ -0,0 +1,38 @@ +name: PlatformIO CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + Build_IRrecvDump_IRMQTTServer: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Cache pip + uses: actions/cache@v2 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + - name: Cache PlatformIO + uses: actions/cache@v2 + with: + path: ~/.platformio + key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} + - name: Set up Python + uses: actions/setup-python@v2 + - name: Install PlatformIO + run: | + python -m pip install --upgrade pip + pip install --upgrade platformio + - name: Build IRrecvDump & IRMQTTServer examples + env: + IRRECVDUMP_RE: .*IRrecvDumpV.* + IRMQTTSERVER_RE: .*IRMQTTServer.* + run: find . -regextype egrep -name platformio.ini -type f \! -regex "${IRRECVDUMP_RE}|${IRMQTTSERVER_RE}" | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir From 83db277c44967c1ba445760b14974f22a63c034e Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Wed, 7 Jul 2021 20:14:29 +1000 Subject: [PATCH 03/18] More workflows & changes * Make a workflow for linters * PlatformIO workflow now does all the examples. - Try to improve caching. * Try to improve UnitTest speed by "-j 2" for Make. * Remove the moved stuff from Travis For #1526 --- .github/workflows/Lint.yml | 28 ++++++++++++++++++++++++++++ .github/workflows/PlatformIO.yml | 9 ++++----- .github/workflows/UnitTests.yml | 4 ++++ .travis.yml | 26 +------------------------- 4 files changed, 37 insertions(+), 30 deletions(-) create mode 100644 .github/workflows/Lint.yml diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml new file mode 100644 index 000000000..fb4c98562 --- /dev/null +++ b/.github/workflows/Lint.yml @@ -0,0 +1,28 @@ +name: Linter + +on: [push] + +jobs: + Linters: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pylint + - name: Analysing the code with pylint + run: | + shopt -s nullglob + pylint -d F0001 {src,test,tools}/*.py + - name: Analysing the code with cpplint + run: | + wget https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py + shopt -s nullglob + python cpplint.py --extensions=c,cc,cpp,ino --headers=h,hpp {src,src/locale,test,tools}/*.{h,c,cc,cpp,hpp,ino} examples/*/*.{h,c,cc,cpp,hpp,ino} diff --git a/.github/workflows/PlatformIO.yml b/.github/workflows/PlatformIO.yml index db71ebea7..e96665af4 100644 --- a/.github/workflows/PlatformIO.yml +++ b/.github/workflows/PlatformIO.yml @@ -7,7 +7,7 @@ on: branches: [ master ] jobs: - Build_IRrecvDump_IRMQTTServer: + Build_Examples: runs-on: ubuntu-latest @@ -31,8 +31,7 @@ jobs: run: | python -m pip install --upgrade pip pip install --upgrade platformio - - name: Build IRrecvDump & IRMQTTServer examples + - name: Build all the examples env: - IRRECVDUMP_RE: .*IRrecvDumpV.* - IRMQTTSERVER_RE: .*IRMQTTServer.* - run: find . -regextype egrep -name platformio.ini -type f \! -regex "${IRRECVDUMP_RE}|${IRMQTTSERVER_RE}" | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir + PLATFORMIO_BUILD_CACHE_DIR: "../../.pio/buildcache" + run: find . -name platformio.ini -type f | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir diff --git a/.github/workflows/UnitTests.yml b/.github/workflows/UnitTests.yml index 6fe3fa055..e19c3a5f9 100644 --- a/.github/workflows/UnitTests.yml +++ b/.github/workflows/UnitTests.yml @@ -16,6 +16,10 @@ jobs: - name: Install the Google test suite run: (cd test; make install-googletest) - name: Build and run the library unit tests. + env: + MAKEFLAGS: "-j 2" run: (cd test; make run) - name: Build and run the tools unit tests. + env: + MAKEFLAGS: "-j 2" run: (cd tools; make all; make run_tests) diff --git a/.travis.yml b/.travis.yml index e606ad056..8a1fdb861 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,18 +8,11 @@ addons: - graphviz - python3.8 - python3-pip - - pylint3 - python3-setuptools -env: - - PLATFORMIO_BUILD_CACHE_DIR="../../.pio/buildcache" - IRRECVDUMP_RE=".*IRrecvDumpV.*" - IRMQTTSERVER_RE=".*IRMQTTServer.*" - MAKEFLAGS="-j 2" cache: directories: - "~/.platformio" before_install: - - wget https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py - python --version && pip --version - python3 --version && pip3 --version - sudo pip3 install -U platformio @@ -31,17 +24,7 @@ notifications: on_failure: change jobs: include: - - name: "Compile the trivial examples" - script: - # Check that everything compiles but some heavy tasks e.g. IRMQTTServer & IRrecvDumpV2+ - # i.e. We are splitting the work load in to parallel tasks. - - find . -regextype egrep -name platformio.ini -type f \! -regex "${IRRECVDUMP_RE}|${IRMQTTSERVER_RE}" | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir - - name: "Compile the IRrecvDumpV2+ examples" - script: - # Check that IRrecvDumpV2+ compiles. - # i.e. We are splitting the work load in to parallel tasks. - - find . -regextype egrep -name platformio.ini -type f -regex "${IRRECVDUMP_RE}" | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir - - name: "Linter, Doc checks, & Compile IRMQTTServer" + - name: "Misc & Doc checks" script: # Run all the Tests & check the code linters have no issues, and that # IRMQTTServer compiles. @@ -50,16 +33,9 @@ jobs: - LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) - test ${LIB_VERSION} == "$(jq -r .version library.json)" - grep -q "^version=${LIB_VERSION}$" library.properties - # Check for lint issues. - - shopt -s nullglob - - python cpplint.py --extensions=c,cc,cpp,ino --headers=h,hpp {src,src/locale,test,tools}/*.{h,c,cc,cpp,hpp,ino} examples/*/*.{h,c,cc,cpp,hpp,ino} - - pylint3 -d F0001 {src,test,tools}/*.py - - shopt -u nullglob # Check that every example directory has a platformio.ini file. - (status=0; for dir in examples/*; do if [[ ! -f "${dir}/platformio.ini" ]]; then echo "${dir} has no 'platform.ini' file!"; status=1; fi; done; exit ${status}) # Check that doxygen completes without errors or warnings. - (DOXYGEN_OUTPUT=$(doxygen 2>&1); if [[ $? -ne 0 || -n "${DOXYGEN_OUTPUT}" ]]; then echo "${DOXYGEN_OUTPUT}"; exit 1; fi) # Check that all files has supported sections. - (SUPPORTED_OUTPUT=$(python3 tools/scrape_supported_devices.py --noout --alert 2>&1); if [[ $? -ne 0 || -n "${SUPPORTED_OUTPUT}" ]]; then echo "${SUPPORTED_OUTPUT}"; exit 1; fi) - # Check that IRMQTTServer compiles. - - find . -regextype egrep -name platformio.ini -type f -regex "${IRMQTTSERVER_RE}" | sed 's,/platformio.ini$,,' | xargs --verbose -n 1 pio run --jobs 2 --project-dir From 5a910e90ef28e208daf1005584a4febfbe96f910 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Wed, 7 Jul 2021 20:35:13 +1000 Subject: [PATCH 04/18] Fix some python linter errors --- tools/auto_analyse_raw_data.py | 5 +++-- tools/scrape_supported_devices.py | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/tools/auto_analyse_raw_data.py b/tools/auto_analyse_raw_data.py index 3b22ea12d..15587d294 100755 --- a/tools/auto_analyse_raw_data.py +++ b/tools/auto_analyse_raw_data.py @@ -303,9 +303,10 @@ def convert_rawdata(data_str): for timing in [x.strip() for x in data_str.split(',')]: try: results.append(int(timing)) - except ValueError: + except ValueError as non_numeric: raise ValueError( - "Raw Data contains a non-numeric value of '%s'." % timing) + "Raw Data contains a non-numeric value of '%s'." % + timing) from non_numeric return results diff --git a/tools/scrape_supported_devices.py b/tools/scrape_supported_devices.py index a9cd10f0a..926847329 100755 --- a/tools/scrape_supported_devices.py +++ b/tools/scrape_supported_devices.py @@ -93,7 +93,7 @@ def getallacs(): match = IRSEND_FN_RE.match(path.name) if match: rawmodels = getenums(path) - for acprotocol in rawmodels: + for acprotocol in rawmodels.keys(): models = set() for model in rawmodels[acprotocol]: model = model.upper() From 92c389ab3a565cf51ddc408d042b892a90b1a668 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Wed, 7 Jul 2021 21:51:22 +1000 Subject: [PATCH 05/18] Another attempt to fix linter error --- tools/scrape_supported_devices.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/scrape_supported_devices.py b/tools/scrape_supported_devices.py index 926847329..8c12bc5f7 100755 --- a/tools/scrape_supported_devices.py +++ b/tools/scrape_supported_devices.py @@ -93,9 +93,9 @@ def getallacs(): match = IRSEND_FN_RE.match(path.name) if match: rawmodels = getenums(path) - for acprotocol in rawmodels.keys(): + for acprotocol, acmodels in rawmodels.items(): models = set() - for model in rawmodels[acprotocol]: + for model in acmodels: model = model.upper() model = model.replace("K{}".format(acprotocol.upper()), "") if model and model not in EXCLUDED_PROTOCOLS: From 861c24fcbfe8388e7855c3e6da3c832f3a14b5be Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Wed, 7 Jul 2021 22:11:01 +1000 Subject: [PATCH 06/18] Try to fix cpplint --- .github/workflows/Lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml index fb4c98562..e5a10b408 100644 --- a/.github/workflows/Lint.yml +++ b/.github/workflows/Lint.yml @@ -17,12 +17,12 @@ jobs: run: | python -m pip install --upgrade pip pip install pylint + pip install cpplint - name: Analysing the code with pylint run: | shopt -s nullglob pylint -d F0001 {src,test,tools}/*.py - name: Analysing the code with cpplint run: | - wget https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py shopt -s nullglob - python cpplint.py --extensions=c,cc,cpp,ino --headers=h,hpp {src,src/locale,test,tools}/*.{h,c,cc,cpp,hpp,ino} examples/*/*.{h,c,cc,cpp,hpp,ino} + cpplint --extensions=c,cc,cpp,ino --headers=h,hpp {src,src/locale,test,tools}/*.{h,c,cc,cpp,hpp,ino} examples/*/*.{h,c,cc,cpp,hpp,ino} From 57ad14c979a346bacd38f38c289386cb5ba59da2 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 14:34:15 +1000 Subject: [PATCH 07/18] Move the Misc checks to GitHub Actions. * Remove moved checks from Travis * Cleanup & improvement to Library Linter workflow. --- .../arduino_library_manager_linter.yml | 27 ++++++++++++++++++- .travis.yml | 16 +---------- 2 files changed, 27 insertions(+), 16 deletions(-) diff --git a/.github/workflows/arduino_library_manager_linter.yml b/.github/workflows/arduino_library_manager_linter.yml index 8a2f90b91..8eb914789 100644 --- a/.github/workflows/arduino_library_manager_linter.yml +++ b/.github/workflows/arduino_library_manager_linter.yml @@ -1,6 +1,6 @@ # This is a basic workflow that is triggered on push/PRs to the master branch. -name: Arduino Library Manager Linter +name: Library Linter # Controls when the action will run. Workflow runs when manually triggered using the UI # or API. @@ -15,6 +15,7 @@ jobs: arduino-lint: runs-on: ubuntu-latest steps: + - name: Arduino Library Manager Linter. - uses: actions/checkout@v2 - uses: arduino/arduino-lint-action@v1 with: @@ -32,3 +33,27 @@ jobs: - uses: actions/checkout@v2 - name: Look for case-insensitive filename collisions. run: DUPS=$(find . -path '*/.pio' -prune -o -print | sort | uniq -D -i); if [[ -n "${DUPS}" ]]; then echo -e "Duplicates found:\n${DUPS}"; false; fi + version-number-consitent: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Check all the version numbers match. + run: | + LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) + test ${LIB_VERSION} == "$(jq -r .version library.json)" + grep -q "^version=${LIB_VERSION}$" library.properties + # Check that every example directory has a platformio.ini file. + - (status=0; for dir in examples/*; do if [[ ! -f "${dir}/platformio.ini" ]]; then echo "${dir} has no 'platform.ini' file!"; status=1; fi; done; exit ${status}) + # Check that doxygen completes without errors or warnings. + examples-have-platformio.ini: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Check that every example directory has a platformio.ini file. + run: (status=0; for dir in examples/*; do if [[ ! -f "${dir}/platformio.ini" ]]; then echo "${dir} has no 'platform.ini' file!"; status=1; fi; done; exit ${status}) + supported-devices-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Check that all files have supported sections. + run: (SUPPORTED_OUTPUT=$(python3 tools/scrape_supported_devices.py --noout --alert 2>&1); if [[ $? -ne 0 || -n "${SUPPORTED_OUTPUT}" ]]; then echo "${SUPPORTED_OUTPUT}"; exit 1; fi) diff --git a/.travis.yml b/.travis.yml index 8a1fdb861..fe64bc083 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,8 +15,6 @@ cache: before_install: - python --version && pip --version - python3 --version && pip3 --version - - sudo pip3 install -U platformio - - pio update script: echo Running checks notifications: email: @@ -24,18 +22,6 @@ notifications: on_failure: change jobs: include: - - name: "Misc & Doc checks" + - name: "Doc checks" script: - # Run all the Tests & check the code linters have no issues, and that - # IRMQTTServer compiles. - # i.e. We are splitting the work load in to parallel tasks. - # Check the version numbers match. - - LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) - - test ${LIB_VERSION} == "$(jq -r .version library.json)" - - grep -q "^version=${LIB_VERSION}$" library.properties - # Check that every example directory has a platformio.ini file. - - (status=0; for dir in examples/*; do if [[ ! -f "${dir}/platformio.ini" ]]; then echo "${dir} has no 'platform.ini' file!"; status=1; fi; done; exit ${status}) - # Check that doxygen completes without errors or warnings. - (DOXYGEN_OUTPUT=$(doxygen 2>&1); if [[ $? -ne 0 || -n "${DOXYGEN_OUTPUT}" ]]; then echo "${DOXYGEN_OUTPUT}"; exit 1; fi) - # Check that all files has supported sections. - - (SUPPORTED_OUTPUT=$(python3 tools/scrape_supported_devices.py --noout --alert 2>&1); if [[ $? -ne 0 || -n "${SUPPORTED_OUTPUT}" ]]; then echo "${SUPPORTED_OUTPUT}"; exit 1; fi) From 34911f76da6867c9fa9cfc0b8d81f049d7b54af9 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 14:44:40 +1000 Subject: [PATCH 08/18] Fix errors library manager workflow * Also more cleanup. --- .github/workflows/Lint.yml | 2 +- .github/workflows/arduino_library_manager_linter.yml | 8 ++------ 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml index e5a10b408..71f572d5e 100644 --- a/.github/workflows/Lint.yml +++ b/.github/workflows/Lint.yml @@ -1,4 +1,4 @@ -name: Linter +name: Source Code Linter on: [push] diff --git a/.github/workflows/arduino_library_manager_linter.yml b/.github/workflows/arduino_library_manager_linter.yml index 8eb914789..7aea17403 100644 --- a/.github/workflows/arduino_library_manager_linter.yml +++ b/.github/workflows/arduino_library_manager_linter.yml @@ -12,7 +12,7 @@ on: # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: - arduino-lint: + arduino-library-manager-lint: runs-on: ubuntu-latest steps: - name: Arduino Library Manager Linter. @@ -21,14 +21,13 @@ jobs: with: library-manager: update compliance: strict - detect-duplicate-files: # Detect case-insensitive file duplication in the same directory. # This can cause a problem for the Arduino IDE on Windows & Macs. # See: # - https://github.com/arduino/Arduino/issues/11441 # - https://github.com/crankyoldgit/IRremoteESP8266/issues/1451 + detect-duplicate-files: runs-on: ubuntu-latest - steps: - uses: actions/checkout@v2 - name: Look for case-insensitive filename collisions. @@ -42,9 +41,6 @@ jobs: LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) test ${LIB_VERSION} == "$(jq -r .version library.json)" grep -q "^version=${LIB_VERSION}$" library.properties - # Check that every example directory has a platformio.ini file. - - (status=0; for dir in examples/*; do if [[ ! -f "${dir}/platformio.ini" ]]; then echo "${dir} has no 'platform.ini' file!"; status=1; fi; done; exit ${status}) - # Check that doxygen completes without errors or warnings. examples-have-platformio.ini: runs-on: ubuntu-latest steps: From d489a55285b9ec9d71094d094bd69476ae5f1bb3 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 14:50:01 +1000 Subject: [PATCH 09/18] Another fix. --- .github/workflows/arduino_library_manager_linter.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/arduino_library_manager_linter.yml b/.github/workflows/arduino_library_manager_linter.yml index 7aea17403..084d5bec4 100644 --- a/.github/workflows/arduino_library_manager_linter.yml +++ b/.github/workflows/arduino_library_manager_linter.yml @@ -15,7 +15,6 @@ jobs: arduino-library-manager-lint: runs-on: ubuntu-latest steps: - - name: Arduino Library Manager Linter. - uses: actions/checkout@v2 - uses: arduino/arduino-lint-action@v1 with: From ec6b18b4aef51e4f681879b71c6f9b79f60da641 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 14:53:03 +1000 Subject: [PATCH 10/18] Fix error in name --- .github/workflows/arduino_library_manager_linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/arduino_library_manager_linter.yml b/.github/workflows/arduino_library_manager_linter.yml index 084d5bec4..2866ffc37 100644 --- a/.github/workflows/arduino_library_manager_linter.yml +++ b/.github/workflows/arduino_library_manager_linter.yml @@ -40,7 +40,7 @@ jobs: LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) test ${LIB_VERSION} == "$(jq -r .version library.json)" grep -q "^version=${LIB_VERSION}$" library.properties - examples-have-platformio.ini: + examples-have-platformio_ini: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 From 85ec8cb019c93bbfb2994872bd9bf20e6c30934f Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 15:50:57 +1000 Subject: [PATCH 11/18] Move doxygen check to workflow * Doxygen check moved to github workflow. * No more travis checks, so remove file. --- .github/workflows/Documentation.yml | 21 +++++++++++++++++++++ .travis.yml | 27 --------------------------- 2 files changed, 21 insertions(+), 27 deletions(-) create mode 100644 .github/workflows/Documentation.yml delete mode 100644 .travis.yml diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml new file mode 100644 index 000000000..adea2b302 --- /dev/null +++ b/.github/workflows/Documentation.yml @@ -0,0 +1,21 @@ +# This is a basic workflow that is triggered on push/PRs to the master branch. + +name: Documentation + +# Controls when the action will run. Workflow runs when manually triggered using the UI +# or API. +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + Doxygen: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: SteffenSeckler/doxygen-action@v2.2.0beta4 + with: + fail-on-warnings: true diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index fe64bc083..000000000 --- a/.travis.yml +++ /dev/null @@ -1,27 +0,0 @@ -dist: bionic -language: c -addons: - apt: - packages: - - jq - - doxygen - - graphviz - - python3.8 - - python3-pip - - python3-setuptools -cache: - directories: - - "~/.platformio" -before_install: - - python --version && pip --version - - python3 --version && pip3 --version -script: echo Running checks -notifications: - email: - on_success: change - on_failure: change -jobs: - include: - - name: "Doc checks" - script: - - (DOXYGEN_OUTPUT=$(doxygen 2>&1); if [[ $? -ne 0 || -n "${DOXYGEN_OUTPUT}" ]]; then echo "${DOXYGEN_OUTPUT}"; exit 1; fi) From de215d26752c195c66ac7ddeee1e089188213bc5 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 16:08:19 +1000 Subject: [PATCH 12/18] Update status badges. * Move from Travis to the new GitHub Workflows. * Remove old non-updating badges. For #1522 --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index de007d9c8..940c553c4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build Status](https://travis-ci.com/crankyoldgit/IRremoteESP8266.svg?branch=master)](https://travis-ci.com/crankyoldgit/IRremoteESP8266) +![Build Status](https://github.com/github/docs/actions/workflows/PlatformIO.yml/badge.svg) +![Code Lint](https://github.com/github/docs/actions/workflows/Lint.yml/badge.svg) +![Tests](https://github.com/github/docs/actions/workflows/UnitTests.yml/badge.svg) +![Documentation](https://github.com/github/docs/actions/workflows/Documentation.yml/badge.svg) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/crankyoldgit/IRremoteESP8266.svg)](http://isitmaintained.com/project/crankyoldgit/IRremoteESP8266 "Average time to resolve an issue") -[![Percentage of issues still open](http://isitmaintained.com/badge/open/crankyoldgit/IRremoteESP8266.svg)](http://isitmaintained.com/project/crankyoldgit/IRremoteESP8266 "Percentage of issues still open") [![GitLicense](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) This library enables you to **send _and_ receive** infra-red signals on an [ESP8266](https://github.com/esp8266/Arduino) or an From 9dd82938dbcc32abee4950027ffe70f84914667d Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 16:21:34 +1000 Subject: [PATCH 13/18] Fix badge issue * Cut & paste fail. Fixed. * Add to FR and DE files. For #1522 --- README.md | 8 ++++---- README_de.md | 8 +++++--- README_fr.md | 9 +++++---- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 940c553c4..f1b998743 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -![Build Status](https://github.com/github/docs/actions/workflows/PlatformIO.yml/badge.svg) -![Code Lint](https://github.com/github/docs/actions/workflows/Lint.yml/badge.svg) -![Tests](https://github.com/github/docs/actions/workflows/UnitTests.yml/badge.svg) -![Documentation](https://github.com/github/docs/actions/workflows/Documentation.yml/badge.svg) +![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg) +![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg) +![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg) +![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![GitLicense](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) diff --git a/README_de.md b/README_de.md index 690ce281a..b623d40de 100644 --- a/README_de.md +++ b/README_de.md @@ -1,9 +1,11 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build-Status](https://travis-ci.com/crankyoldgit/IRremoteESP8266.svg?branch=master)](https://travis-ci.com/crankyoldgit/IRremoteESP8266) +![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg) +![Code-Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg) +![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg) +![Dokumentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg) +[![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![Arduino-Bibliothek-Abzeichen](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) -[![Durchschnittliche Zeit bis zur Problemlösung](http://isitmaintained.com/badge/resolution/crankyoldgit/IRremoteESP8266.svg)](http://isitmaintained.com/project/crankyoldgit/IRremoteESP8266 "Resolution Time") -[![Prozentsatz der offenen Probleme](http://isitmaintained.com/badge/open/crankyoldgit/IRremoteESP8266.svg)](http://isitmaintained.com/project/crankyoldgit/IRremoteESP8266 "Open issues") [![Git-Lizenz](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) Diese Programmbibliothek ermöglicht das **Senden _und_ Empfangen** von Infrarotsignalen mit [ESP8266](https://github.com/esp8266/Arduino)- und diff --git a/README_fr.md b/README_fr.md index c87ab75cf..c17635834 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,11 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build Status](https://travis-ci.com/crankyoldgit/IRremoteESP8266.svg?branch=master)](https://travis-ci.com/crankyoldgit/IRremoteESP8266) +![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg) +![Charbon de code](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg) +![Essais](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg) +![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/crankyoldgit/IRremoteESP8266.svg)](http://isitmaintained.com/project/crankyoldgit/IRremoteESP8266 "Average time to resolve an issue") -[![Percentage of issues still open](http://isitmaintained.com/badge/open/crankyoldgit/IRremoteESP8266.svg)](http://isitmaintained.com/project/crankyoldgit/IRremoteESP8266 "Percentage of issues still open") -[![GitLicense](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) +[![LicenseGit](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) Cette librairie vous permetra de **recevoir et d'envoyer des signaux** infrarouge sur le protocole [ESP8266](https://github.com/esp8266/Arduino) ou sur le protocole [ESP32](https://github.com/espressif/arduino-esp32) en utilisant le [Arduino framework](https://www.arduino.cc/) qui utilise la norme 940nm IR LEDs et le module basique de reception d'onde IR. Exemple : TSOP{17,22,24,36,38,44,48}* modules etc. From efb814cb2c0e20661cf0219cdc1a8d44a668d9f6 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 16:30:29 +1000 Subject: [PATCH 14/18] Use better names in the Workflows Turns out the status badges use these to name the badges. So pick ones we'd like to see in the badges. For #1522 --- .github/workflows/Lint.yml | 2 +- .github/workflows/PlatformIO.yml | 2 +- .github/workflows/UnitTests.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml index 71f572d5e..198e536a6 100644 --- a/.github/workflows/Lint.yml +++ b/.github/workflows/Lint.yml @@ -1,4 +1,4 @@ -name: Source Code Linter +name: Code Lint on: [push] diff --git a/.github/workflows/PlatformIO.yml b/.github/workflows/PlatformIO.yml index e96665af4..5c0e5907c 100644 --- a/.github/workflows/PlatformIO.yml +++ b/.github/workflows/PlatformIO.yml @@ -1,4 +1,4 @@ -name: PlatformIO CI +name: Build on: push: diff --git a/.github/workflows/UnitTests.yml b/.github/workflows/UnitTests.yml index e19c3a5f9..22c2b2583 100644 --- a/.github/workflows/UnitTests.yml +++ b/.github/workflows/UnitTests.yml @@ -1,4 +1,4 @@ -name: Unit tests +name: Tests on: push: From 6433ddbbe126c4cd86ebb18edb2e0ceebd5fc5b9 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 16:40:57 +1000 Subject: [PATCH 15/18] Make the new status badges be links to the relevent actions. --- README.md | 8 ++++---- README_de.md | 8 ++++---- README_fr.md | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f1b998743..af8a3974c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg) -![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg) -![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg) -![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg) +[![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](actions/workflows/PlatformIO.yml) +[![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](actions/workflows/PlatformIO.yml) +[![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](actions/workflows/UnitTests.yml) +[![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](actions/workflows/Documentation.yml/badge.svg) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![GitLicense](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) diff --git a/README_de.md b/README_de.md index b623d40de..d8773cd32 100644 --- a/README_de.md +++ b/README_de.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg) -![Code-Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg) -![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg) -![Dokumentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg) +[![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](actions/workflows/PlatformIO.yml/badge.svg) +[![Code-Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](actions/workflows/Lint.yml) +[![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](actions/workflows/UnitTests.yml) +[![Dokumentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](actions/workflows/Documentation.yml) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![Arduino-Bibliothek-Abzeichen](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![Git-Lizenz](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) diff --git a/README_fr.md b/README_fr.md index c17635834..29a2f7a4a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg) -![Charbon de code](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg) -![Essais](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg) -![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg) +[![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](actions/workflows/PlatformIO.yml) +[![Charbon de code](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](actions/workflows/Lint.yml) +[![Essais](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](actions/workflows/UnitTests.yml) +[![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](actions/workflows/Documentation.yml) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![LicenseGit](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) From d4270c43dd67cad5485948ca9e2a933a83716478 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 16:44:24 +1000 Subject: [PATCH 16/18] Hopefully with the correct URL this time. --- README.md | 8 ++++---- README_de.md | 8 ++++---- README_fr.md | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index af8a3974c..558f87a63 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](actions/workflows/PlatformIO.yml) -[![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](actions/workflows/PlatformIO.yml) -[![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](actions/workflows/UnitTests.yml) -[![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](actions/workflows/Documentation.yml/badge.svg) +[![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](../../actions/workflows/PlatformIO.yml) +[![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/PlatformIO.yml) +[![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](../../actions/workflows/UnitTests.yml) +[![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](../../actions/workflows/Documentation.yml/badge.svg) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![GitLicense](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) diff --git a/README_de.md b/README_de.md index d8773cd32..9644112c7 100644 --- a/README_de.md +++ b/README_de.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](actions/workflows/PlatformIO.yml/badge.svg) -[![Code-Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](actions/workflows/Lint.yml) -[![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](actions/workflows/UnitTests.yml) -[![Dokumentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](actions/workflows/Documentation.yml) +[![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](../../actions/workflows/PlatformIO.yml/badge.svg) +[![Code-Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/Lint.yml) +[![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](../../ctions/workflows/UnitTests.yml) +[![Dokumentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](../../actions/workflows/Documentation.yml) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![Arduino-Bibliothek-Abzeichen](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![Git-Lizenz](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) diff --git a/README_fr.md b/README_fr.md index 29a2f7a4a..365d42000 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,9 +1,9 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](actions/workflows/PlatformIO.yml) -[![Charbon de code](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](actions/workflows/Lint.yml) -[![Essais](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](actions/workflows/UnitTests.yml) -[![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](actions/workflows/Documentation.yml) +[![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](../../actions/workflows/PlatformIO.yml) +[![Charbon de code](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/Lint.yml) +[![Essais](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](../../actions/workflows/UnitTests.yml) +[![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](../../actions/workflows/Documentation.yml) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) [![LicenseGit](https://gitlicense.com/badge/crankyoldgit/IRremoteESP8266)](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) From 90984e44c85841cf47ae87f7eb64e7597b5ff99f Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Thu, 8 Jul 2021 21:57:56 +1000 Subject: [PATCH 17/18] Rename workflow files & remove Travis references. * Make the workflow `.yml` file names more consistent. * Remove references to Travis. --- .github/CONTRIBUTING.md | 2 +- .github/workflows/{PlatformIO.yml => Build.yml} | 0 .../{arduino_library_manager_linter.yml => MetaChecks.yml} | 0 README.md | 4 ++-- README_de.md | 2 +- README_fr.md | 2 +- 6 files changed, 5 insertions(+), 5 deletions(-) rename .github/workflows/{PlatformIO.yml => Build.yml} (100%) rename .github/workflows/{arduino_library_manager_linter.yml => MetaChecks.yml} (100%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 20bb97d94..87fd34fc1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -71,7 +71,7 @@ Include details about your configuration, circuit and environment: * Avoid platform-dependent code. * Use c98 types where possible for better portablity. * In almost all cases, code & documentation should be peer-reviewed by at least one other contributor. -* The code should pass all the existing testing infrastructure in Travis. e.g. Unit tests, cpplint, and basic compilation. +* The code should pass all the existing testing infrastructure in GitHub Actions. e.g. Unit tests, cpplint, and basic compilation etc. * State if you have tested this under real conditions if you have, and what other tests you may have carried out. ### Git Commit Messages diff --git a/.github/workflows/PlatformIO.yml b/.github/workflows/Build.yml similarity index 100% rename from .github/workflows/PlatformIO.yml rename to .github/workflows/Build.yml diff --git a/.github/workflows/arduino_library_manager_linter.yml b/.github/workflows/MetaChecks.yml similarity index 100% rename from .github/workflows/arduino_library_manager_linter.yml rename to .github/workflows/MetaChecks.yml diff --git a/README.md b/README.md index 558f87a63..8f563b01e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](../../actions/workflows/PlatformIO.yml) -[![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/PlatformIO.yml) +[![Build Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Build.yml/badge.svg)](../../actions/workflows/Build.yml) +[![Code Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/Lint.yml) [![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](../../actions/workflows/UnitTests.yml) [![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](../../actions/workflows/Documentation.yml/badge.svg) [![arduino-library-badge](https://www.ardu-badge.com/badge/IRremoteESP8266.svg?)](https://www.ardu-badge.com/IRremoteESP8266) diff --git a/README_de.md b/README_de.md index 9644112c7..d7cc16a7a 100644 --- a/README_de.md +++ b/README_de.md @@ -1,6 +1,6 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](../../actions/workflows/PlatformIO.yml/badge.svg) +[![Build-Status](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Build.yml/badge.svg)](../../actions/workflows/Build.yml/badge.svg) [![Code-Lint](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/Lint.yml) [![Tests](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](../../ctions/workflows/UnitTests.yml) [![Dokumentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](../../actions/workflows/Documentation.yml) diff --git a/README_fr.md b/README_fr.md index 365d42000..c46bd2750 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ ![IRremoteESP8266 Library](./assets/images/banner.svg) -[![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/PlatformIO.yml/badge.svg)](../../actions/workflows/PlatformIO.yml) +[![Construire](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Build.yml/badge.svg)](../../actions/workflows/Build.yml) [![Charbon de code](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Lint.yml/badge.svg)](../../actions/workflows/Lint.yml) [![Essais](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/UnitTests.yml/badge.svg)](../../actions/workflows/UnitTests.yml) [![Documentation](https://github.com/crankyoldgit/IRremoteESP8266/actions/workflows/Documentation.yml/badge.svg)](../../actions/workflows/Documentation.yml) From d62bd5bcee78ca063a77358d6825611ac387dc08 Mon Sep 17 00:00:00 2001 From: crankyoldgit Date: Sat, 10 Jul 2021 11:22:59 +1000 Subject: [PATCH 18/18] Add "-j 2" for google test suite - Caught in code review. --- .github/workflows/UnitTests.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/UnitTests.yml b/.github/workflows/UnitTests.yml index 22c2b2583..699038e88 100644 --- a/.github/workflows/UnitTests.yml +++ b/.github/workflows/UnitTests.yml @@ -14,6 +14,8 @@ jobs: steps: - uses: actions/checkout@v2 - name: Install the Google test suite + env: + MAKEFLAGS: "-j 2" run: (cd test; make install-googletest) - name: Build and run the library unit tests. env: