Merge branch 'main' into banglejs2

Author: tannewt

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -6,7 +6,7 @@ body:
   - type: markdown
     attributes:
       value: >-
-        Thanks! for testing out CircuitPython. Now that you have encountered a
+        Thanks for testing out CircuitPython! Now that you have encountered a
         bug... you can file a report for it.
   - type: textarea
     id: firmware

.github/actions/deps/external/action.yml

@@ -1,6 +1,14 @@
 name: Fetch external deps
 
 inputs:
+  action:
+    required: false
+    default: restore
+    type: choice
+    options:
+    - cache
+    - restore
+
   platform:
     required: false
     default: none
@@ -94,7 +102,7 @@ runs:
       if: inputs.platform != 'esp'
       uses: ./.github/actions/deps/python
       with:
-        action: ${{ fromJSON('["restore", "cache"]')[github.job == 'scheduler'] }}
+        action: ${{ inputs.action }}
     - name: Install python dependencies
       run: pip install -r requirements-dev.txt
       shell: bash

.github/actions/upload_aws/action.yml

@@ -24,7 +24,8 @@ runs:
         (github.event_name == 'release' && (github.event.action == 'published' || github.event.action == 'rerequested'))
       run: >-
         [ -z "$AWS_ACCESS_KEY_ID" ] ||
-        aws s3 cp ${{ inputs.source }} s3://adafruit-circuit-python/bin/${{ inputs.destination }} --recursive --no-progress --region us-east-1
+        aws s3 cp ${{ inputs.source }} s3://adafruit-circuit-python/bin/${{ inputs.destination }}
+        ${{ endsWith(inputs.source, '/') && '--recursive' || '' }} --no-progress --region us-east-1
       env:
         AWS_PAGER: ''
         AWS_ACCESS_KEY_ID: ${{ inputs.AWS_ACCESS_KEY_ID }}

.github/workflows/build-boards-custom.yml

@@ -0,0 +1,104 @@
+name: Custom board build
+
+on:
+  workflow_dispatch:
+    inputs:
+      board:
+        description: 'Board: Found in ports/*/boards/[board_id]'
+        required: true
+        type: string
+      version:
+        description: 'Version: Can be a tag or a commit (>=8.1.0)'
+        required: false
+        default: latest
+        type: string
+      language:
+        description: 'Language: Found in locale/[language].po'
+        required: false
+        default: en_US
+        type: string
+      flags:
+        description: 'Flags: Build flags (e.g. CIRCUITPY_WIFI=1)'
+        required: false
+        type: string
+      debug:
+        description: 'Make a debug build'
+        required: false
+        default: false
+        type: boolean
+
+run-name: ${{ inputs.board }}-${{ inputs.language }}-${{ inputs.version }}${{ inputs.flags != '' && '-custom' || '' }}${{ inputs.debug && '-debug' || '' }}
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    env:
+      PLATFORM_atmel-samd: arm
+      PLATFORM_broadcom: aarch
+      PLATFORM_cxd56: arm
+      PLATFORM_espressif: esp
+      PLATFORM_litex: riscv
+      PLATFORM_mimxrt10xx: arm
+      PLATFORM_nrf: arm
+      PLATFORM_raspberrypi: arm
+      PLATFORM_stm: arm
+    steps:
+    - name: Set up repository
+      run: |
+        git clone --filter=tree:0 https://github.com/adafruit/circuitpython.git $GITHUB_WORKSPACE
+        git checkout ${{ inputs.version == 'latest' && 'HEAD' || inputs.version }}
+    - name: Set up identifier
+      if: inputs.debug || inputs.flags != ''
+      run: |
+        > custom-build && git add custom-build
+    - name: Get port
+      id: get-port
+      run: |
+        PORT=$(find ports/*/boards/ -type d -name ${{ inputs.board }} | sed 's/^ports\///g;s/\/boards.*//g')
+        if [ -z $PORT ]; then (exit 1); else echo >> $GITHUB_OUTPUT "port=$PORT"; fi
+    - name: Port to platform
+      run: echo >> $GITHUB_ENV "PLATFORM=${{ env[format('PLATFORM_{0}', steps.get-port.outputs.port)] }}"
+    - name: Set up python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+    - name: Set up port
+      if: env.PLATFORM == 'esp'
+      uses: ./.github/actions/deps/ports/espressif
+    - name: Set up submodules
+      id: set-up-submodules
+      uses: ./.github/actions/deps/submodules
+      with:
+        action: cache
+        target: ${{ inputs.board }}
+    - name: Set up external
+      uses: ./.github/actions/deps/external
+      with:
+        action: cache
+        platform: ${{ env.PLATFORM }}
+    - name: Set up mpy-cross
+      if: steps.set-up-submodules.outputs.frozen == 'True'
+      uses: ./.github/actions/mpy_cross
+      with:
+        download: false
+    - name: Versions
+      run: |
+        tools/describe
+        gcc --version
+        python3 --version
+        cmake --version || true
+        ninja --version || true
+        aarch64-none-elf-gcc --version || true
+        arm-none-eabi-gcc --version || true
+        xtensa-esp32-elf-gcc --version || true
+        riscv32-esp-elf-gcc --version || true
+        riscv64-unknown-elf-gcc --version || true
+        mkfs.fat --version || true
+    - name: Build board
+      run: make -j2 ${{ inputs.flags }} BOARD=${{ inputs.board }} DEBUG=${{ inputs.debug && '1' || '0' }} TRANSLATION=${{ inputs.language }}
+      working-directory: ports/${{ steps.get-port.outputs.port }}
+    - name: Upload artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: ${{ inputs.board }}-${{ inputs.language }}-${{ inputs.version }}${{ inputs.flags != '' && '-custom' || '' }}${{ inputs.debug && '-debug' || '' }}
+        path: ports/${{ steps.get-port.outputs.port }}/build-${{ inputs.board }}/firmware.*

.github/workflows/build.yml

@@ -53,6 +53,8 @@ jobs:
         version: true
     - name: Set up external
       uses: ./.github/actions/deps/external
+      with:
+        action: cache
     # Disabled: Needs to be updated
     # - name: Get last commit with checks
     #   id: get-last-commit-with-checks
@@ -201,16 +203,11 @@ jobs:
       with:
         name: docs
         path: _build/latex
-    - name: Zip stubs
-      if: >-
-        (github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository_owner == 'adafruit') ||
-        (github.event_name == 'release' && (github.event.action == 'published' || github.event.action == 'rerequested'))
-      run: zip -9r circuitpython-stubs.zip circuitpython-stubs
     - name: Upload to S3
       uses: ./.github/actions/upload_aws
       with:
         source: circuitpython-stubs/dist/*.tar.gz
-        destination: stubs/circuitpython-stubs-${{ env.CP_VERSION }}.zip
+        destination: stubs/circuitpython-stubs-${{ env.CP_VERSION }}.tar.gz
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
     - name: Upload stubs to PyPi

Makefile

@@ -323,10 +323,11 @@ clean-nrf:
 clean-stm:
 	$(MAKE) -C ports/stm BOARD=feather_stm32f405_express clean
 
+
+# This update will fail because the commits we need aren't the latest on the
+# branch. We can ignore that though because we fix it with the second command.
+# (Only works for git servers that allow sha fetches.)
 .PHONY: fetch-submodules
 fetch-submodules:
-	# This update will fail because the commits we need aren't the latest on the
-	# branch. We can ignore that though because we fix it with the second command.
-	# (Only works for git servers that allow sha fetches.)
 	git submodule update --init -N --depth 1 || true
 	git submodule foreach 'git fetch --tags --depth 1 origin $$sha1 && git checkout -q $$sha1'

README.rst

@@ -138,16 +138,26 @@ Behavior
 -  Adds a safe mode that does not run user code after a hard crash or brown out. This makes it
    possible to fix code that causes nasty crashes by making it available through mass storage after
    the crash. A reset (the button) is needed after it's fixed to get back into normal mode.
+-  Safe mode may be handled programmatically by providing a ``safemode.py``.
+   ``safemode.py`` is run if the board has reset due to entering safe mode, unless the safe mode
+   initiated by the user by pressing button(s).
+   USB is not available so nothing can be printed.
+   ``safemode.py`` can determine why the safe mode occurred
+   using ``supervisor.runtime.safe_mode_reason``, and take appropriate action. For instance,
+   if a hard crash occurred, ``safemode.py`` may do a ``microcontroller.reset()``
+   to automatically restart despite the crash.
+   If the battery is low, but is being charged, ``safemode.py`` may put the board in deep sleep
+   for a while. Or it may simply reset, and have ``code.py`` check the voltage and do the sleep.
 -  RGB status LED indicating CircuitPython state.
    - One green flash - code completed without error.
    - Two red flashes - code ended due to an exception.
    - Three yellow flashes - safe mode. May be due to CircuitPython internal error.
 -  Re-runs ``code.py`` or other main file after file system writes by a workflow. (Disable with
    ``supervisor.disable_autoreload()``)
 -  Autoreload is disabled while the REPL is active.
--  Main is one of these: ``code.txt``, ``code.py``, ``main.py``,
-   ``main.txt``
--  Boot is one of these: ``boot.py``, ``boot.txt``
+-  ``code.py`` may also be named``code.txt``, ``main.py``, or ``main.txt``.
+-  ``boot.py`` may also be named ``boot.txt``.
+-  ``safemode.py`` may also be named ``safemode.txt``.
 
 API
 ~~~