diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index fa98ee41..67cdd8c9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: 🐞 Bug Report -description: Use this form if you think you found a bug +description: Use this form if you think you found a bug / Verwende dieses Formular, wenn Du denkst, dass Du einen Fehler gefunden hast. labels: bug body: @@ -14,6 +14,8 @@ body: - [ ] Is there already another similar issue? Check for open and closed [Issue](https://github.com/jomjol/AI-on-the-edge-device/issues) and [Discussions](https://github.com/jomjol/AI-on-the-edge-device/discussions). - [ ] Are instructions in the [README](https://github.com/jomjol/AI-on-the-edge-device/tree/master#readme) solving your issue? - [ ] Are instructions in the [Wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki) solving your issue? + + Du darfst gerne auch in Deutsch schreiben! @@ -35,6 +37,16 @@ body: + - type: textarea + validations: + required: true + attributes: + label: Logfile + description: Add the logfile (See menu `System > Log Viewer`) to help explain your problem. This will be automatically formatted into code, so no need to format it on your side. + render: shell + + + - type: textarea attributes: label: Expected Behavior @@ -46,7 +58,7 @@ body: attributes: label: Screenshots description: If applicable, add screenshots to help explain your problem. - + - type: textarea diff --git a/.github/ISSUE_TEMPLATE/training.yaml b/.github/ISSUE_TEMPLATE/training.yaml index 956a9b15..c91753c2 100644 --- a/.github/ISSUE_TEMPLATE/training.yaml +++ b/.github/ISSUE_TEMPLATE/training.yaml @@ -2,16 +2,18 @@ name: 📖 New Training Data description: Use this form if you collected images and want to provide them for training the model title: New Training Data labels: new training data +assignees: jomjol body: - type: markdown attributes: value: | Before you proceed, please check: - - [ ] Did you follow the guideline as documented in the [Wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki/ROI-Configuration)? We will only be able to accept the files if the fulfill the rules! + - [ ] Did you make sure we don't have similar data yet in the training data? (see [Digital Counters](https://jomjol.github.io/neural-network-digital-counter-readout/) resp. [Analog Needles](https://jomjol.github.io/neural-network-analog-needle-readout)) + - [ ] Did you follow the guideline as documented in the [Wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki/ROI-Configuration)? We will only be able to accept the files if they fulfill the rules! - type: textarea validations: required: true attributes: label: Files - description: You can drag & drop your zipped images here + description: You can drag & drop your **zipped** images here diff --git a/.github/ISSUE_TEMPLATE/x_plain.yaml b/.github/ISSUE_TEMPLATE/x_plain.yaml index 559c9323..afd05084 100644 --- a/.github/ISSUE_TEMPLATE/x_plain.yaml +++ b/.github/ISSUE_TEMPLATE/x_plain.yaml @@ -1,8 +1,8 @@ name: 🗒️ Blank Form -description: Use this form if none of the others fit +description: Use this form if none of the others fit. Please only use none of the others fit! body: - type: textarea attributes: - label: The Problem + label: Issue diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 880cc674..a35963cb 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,6 +1,6 @@ name: Build and Pack -on: [push] +on: [push, pull_request] jobs: ######################################################################################### @@ -10,23 +10,30 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - id: skip_check + uses: fkirc/skip-duplicate-actions@v5 + with: + concurrent_skipping: same_content_newer + + - uses: actions/checkout@v3 with: submodules: recursive - name: Set Variables id: vars run: | - echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" + echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT - name: Cache PlatformIO - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.platformio key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} - name: Set up Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 + with: + python-version: '3.10' - name: Install PlatformIO run: | python -m pip install --upgrade pip @@ -59,7 +66,7 @@ jobs: needs: build steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Get generated files from cache uses: actions/cache@v3 @@ -74,24 +81,25 @@ jobs: - name: Set Variables id: vars run: | - echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" + echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT + echo "branch=$(echo ${{ github.ref_name }} | tr / __)" >> $GITHUB_OUTPUT - name: Rename firmware file to contain versioning (old ota) run: | mkdir -p ./dist_old_ota - cp "./code/.pio/build/esp32cam/firmware.bin" "./dist_old_ota/firmware__${{ github.ref_name }}_(${{ steps.vars.outputs.sha_short }}).bin" + cp "./code/.pio/build/esp32cam/firmware.bin" "./dist_old_ota/firmware__${{ steps.vars.outputs.branch }}_(${{ steps.vars.outputs.sha_short }}).bin" - name: Upload Firmware artifact (old OTA concept) uses: actions/upload-artifact@v3 with: # name: "firmware__${{ github.ref_name }}__(${{ steps.vars.outputs.sha_short }})__(extract_before_upload__only_needed_for_migration_from_11.3.1)" - name: "firmware__(extract_before_upload)__${{ github.ref_name }}__(${{ steps.vars.outputs.sha_short }})" + name: "firmware__(extract_before_upload)__${{ steps.vars.outputs.branch }}__(${{ steps.vars.outputs.sha_short }})" path: ./dist_old_ota/* - name: Upload Web interface artifact (old OTA concept) uses: actions/upload-artifact@v3 with: - name: "html__${{ github.ref_name }}__(${{ steps.vars.outputs.sha_short }})" + name: "html__${{ steps.vars.outputs.branch }}__(${{ steps.vars.outputs.sha_short }})" path: ./sd-card/html/* @@ -109,7 +117,7 @@ jobs: needs: build steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Get generated files from cache uses: actions/cache@v3 @@ -124,7 +132,8 @@ jobs: - name: Set Variables id: vars run: | - echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" + echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT + echo "branch=$(echo ${{ github.ref_name }} | tr / __)" >> $GITHUB_OUTPUT - name: Prepare update.zip artifact run: | @@ -155,7 +164,7 @@ jobs: - name: Upload dist as update.zip artifact (Firmware + Web UI + CNN) uses: actions/upload-artifact@v3 with: - name: "update__${{ github.ref_name }}_(${{ steps.vars.outputs.sha_short }})" + name: "update__${{ steps.vars.outputs.branch }}_(${{ steps.vars.outputs.sha_short }})" path: ./dist/* - name: Store generated files in cache @@ -163,7 +172,7 @@ jobs: with: path: | ./dist - key: ${{ github.run_number }}-pack-for-OTA-v2 + key: ${{ steps.vars.outputs.branch }}-pack-for-OTA-v2 @@ -177,7 +186,7 @@ jobs: needs: build steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Get generated files from cache uses: actions/cache@v3 @@ -189,6 +198,12 @@ jobs: ./sd-card/html/version.txt key: ${{ github.run_number }} + - name: Set Variables + id: vars + run: | + echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT + echo "branch=$(echo ${{ github.ref_name }} | tr / __)" >> $GITHUB_OUTPUT + - name: Prepare artifacts for release run: | mkdir -p firmware @@ -204,7 +219,7 @@ jobs: - name: Upload initial_esp32_setup.zip artifact (Firmware + Bootloader + Partitions + Web UI) uses: actions/upload-artifact@v3 with: - name: "initial_esp32_setup__${{ github.ref_name }}_(${{ steps.vars.outputs.sha_short }})" + name: "initial_esp32_setup__${{ steps.vars.outputs.branch }}_(${{ steps.vars.outputs.sha_short }})" path: ./firmware - name: Store generated files in cache @@ -226,7 +241,7 @@ jobs: if: startsWith(github.ref, 'refs/tags/') steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Get generated files from cache uses: actions/cache@v3 @@ -257,7 +272,7 @@ jobs: - name: Set Variables id: vars run: | - echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" + echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT - name: Prepare artifacts for release