Compare revisions

# top: Update Python formatting to black "2023 stable style".

8b2748269244304854b3462cb8902952b4dcb892

# all: Reformat remaining C code that doesn't have a space after a comma.

5b700b0af90591d6b1a2c087bb8de6b7f1bfdd2d

# ports: Reformat more C and Python source code.

5c32111fa0e31e451b0f1666bdf926be2fdfd82c

# all: Update Python formatting to latest Black version 22.1.0.

ab2923dfa1174dc177f0a90cb00a7e4ff87958d2

# all: Update Python formatting to latest Black version 21.12b0.

3770fab33449a5dadf8eb06edfae0767e75320a6

# tools/gen-cpydiff.py: Fix formatting of doc strings for new Black.

0f78c36c5aa458a954eed39a46942209107a553e

# tests/run-tests.py: Reformat with Black.

2a38d7103672580882fb621a5b76e8d26805d593

# all: Update Python code to conform to latest black formatting.

06659077a81b85882254cf0953c33b27614e018e

# tools/uncrustify: Enable more opts to remove space between func and '('.

77ed6f69ac35c1663a5633a8ee1d8a2446542204

# tools/codeformat.py: Include extmod/{btstack,nimble} in code formatting.

026fda605e03113d6e753290d65fed774418bc53

# all: Format code to add space after C++-style comment start.

84fa3312cfa7d2237d4b56952f2cd6e3591210c4

# tests: Format all Python code with black, except tests in basics subdir.

3dc324d3f1312e40d3a8ed87e7244966bb756f26

# all: Remove spaces inside and around parenthesis.

1a3e386c67e03a79eb768cb6e9f6777e002d6660

# all: Remove spaces between nested paren and inside function arg paren.

feb25775851ba0c04b8d1013716f442258879d9c

# all: Reformat C and Python source code with tools/codeformat.py.

69661f3343bedf86e514337cff63d96cc42f8859

# stm32/usbdev: Convert files to unix line endings.

abde0fa2267f9062b28c3c015d7662a550125cc6

# all: Remove trailing spaces, per coding conventions.

761e4c7ff62896c7d8f8c3dfc3cc98a4cc4f2f6f

# Per default everything gets normalized and gets LF line endings on checkout.

* text eol=lf

# These will always have CRLF line endings on checkout.

*.vcxproj text eol=crlf

*.props text eol=crlf

*.bat text eol=crlf

# These are binary so should never be modified by git.

*.a binary

*.png binary

*.jpg binary

*.dxf binary

*.mpy binary

# These should also not be modified by git.

tests/basics/string_cr_conversion.py -text

tests/basics/string_crlf_conversion.py -text

ports/stm32/pybcdc.inf_template -text

ports/stm32/usbhost/** -text

ports/cc3200/hal/aes.c -text

ports/cc3200/hal/aes.h -text

ports/cc3200/hal/des.c -text

ports/cc3200/hal/i2s.c -text

ports/cc3200/hal/i2s.h -text

ports/cc3200/version.h -text

github: micropython

---

name: Bug report

about: Report an issue

title: ''

labels: bug

assignees: ''

---

* Please search existing issues before raising a new issue. For questions about MicroPython or for help using MicroPython, or any sort of "how do I?" requests, please use the Discussions tab or raise a documentation request instead.

* In your issue, please include a clear and concise description of what the bug is, the expected output, and how to replicate it.

* If this issue involves external hardware, please include links to relevant datasheets and schematics.

* If you are seeing code being executed incorrectly, please provide a minimal example and expected output (e.g. comparison to CPython).

* For build issues, please include full details of your environment, compiler versions, command lines, and build output.

* Please provide as much information as possible about the version of MicroPython you're running, such as:

 - firmware file name

 - git commit hash and port/board

 - version information shown in the REPL (hit Ctrl-B to see the startup message)

* Remove all placeholder text above before submitting.

blank_issues_enabled: false

contact_links:

  - name: MicroPython GitHub Discussions

    url: https://github.com/orgs/micropython/discussions

    about: Community discussion about all things MicroPython. This is the best place to start if you have questions about using MicroPython or getting started with MicroPython development.

  - name: MicroPython Documentation

    url: https://docs.micropython.org/

    about: Documentation for using and working with MicroPython and libraries.

  - name: MicroPython Downloads

    url: https://micropython.org/download/

    about: Pre-built firmware and information for most supported boards.

---

name: Documentation issue

about: Report areas of the documentation or examples that need improvement

title: 'docs: '

labels: documentation

assignees: ''

---

* Please search existing issues before raising a new issue. For questions about MicroPython or for help using MicroPython, or any sort of "how do I?" requests, please use the Discussions tab instead.

* Describe what was missing from the documentation and/or what was incorrect/incomplete.

* If possible, please link to the relevant page on https://docs.micropython.org/

* Remove all placeholder text above before submitting.

---

name: Feature request

about: Request a feature or improvement

title: ''

labels: enhancement

assignees: ''

---

* Please search existing issues before raising a new issue. For questions about MicroPython or for help using MicroPython, or any sort of "how do I?" requests, please use the Discussions tab or raise a documentation request instead.

* Describe the feature you'd like to see added to MicroPython. In particular, what does this feature enable and why is it useful. MicroPython aims to strike a balance between functionality and code size, so please consider whether this feature can be optionally enabled and whether it can be provided in other ways (e.g. pure-Python library).

* For core Python features, where possible please include a link to the relevant PEP.

* For new architectures / ports / boards, please provide links to relevant documentation, specifications, and toolchains. Any information about the popularity and unique features about this hardware would also be useful.

* For features for existing ports (e.g. new peripherals or microcontroller features), please describe which port(s) it applies too, and whether this is could be an extension to the machine API or a port-specific module?

* For drivers (e.g. for external hardware), please link to datasheets and/or existing drivers from other sources.

* Who do you expect will implement the feature you are requesting? Would you be willing to sponsor this work?

* Remove all placeholder text above before submitting.

---

name: Security report

about: Report a security issue or vunerability in MicroPython

title: ''

labels: security

assignees: ''

---

* If you need to raise this issue privately with the MicroPython team, please email contact@micropython.org instead.

* Include a clear and concise description of what the security issue is.

* What does this issue allow an attacker to do?

* Remove all placeholder text above before submitting.

version: 2

updates:

  # Maintain dependencies for GitHub Actions

  - package-ecosystem: "github-actions"

    directory: "/"

    schedule:

      interval: "daily"

name: Check code formatting

on: [push, pull_request]

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build:

    runs-on: ubuntu-22.04

    steps:

    - uses: actions/checkout@v3

    - uses: actions/setup-python@v4

    - name: Install packages

      run: source tools/ci.sh && ci_code_formatting_setup

    - name: Run code formatting

      run: source tools/ci.sh && ci_code_formatting_run

    - name: Check code formatting

      run: git diff --exit-code

name: Check code size

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'tools/**'

      - 'py/**'

      - 'extmod/**'

      - 'lib/**'

      - 'ports/bare-arm/**'

      - 'ports/minimal/**'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build:

    runs-on: ubuntu-20.04

    steps:

    - uses: actions/checkout@v3

      with:

        fetch-depth: 100

    - name: Install packages

      run: source tools/ci.sh && ci_code_size_setup

    - name: Build

      run: source tools/ci.sh && ci_code_size_build

    - name: Compute code size difference

      run: tools/metrics.py diff ~/size0 ~/size1 | tee diff

    - name: Save PR number

      if: github.event_name == 'pull_request'

      env:

        PR_NUMBER: ${{ github.event.number }}

      run: echo $PR_NUMBER > pr_number

    - name: Upload diff

      if: github.event_name == 'pull_request'

      uses: actions/upload-artifact@v3

      with:

        name: code-size-report

        path: |

          diff

          pr_number

        retention-days: 1

name: Code size comment

on:

  workflow_run:

    workflows: [Check code size]

    types: [completed]

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  comment:

    runs-on: ubuntu-20.04

    steps:

      - name: 'Download artifact'

        id: download-artifact

        uses: actions/github-script@v6

        with:

          result-encoding: string

          script: |

            const fs = require('fs');

            const allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({

               owner: context.repo.owner,

               repo: context.repo.repo,

               run_id: context.payload.workflow_run.id,

            });

            const matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {

              return artifact.name == "code-size-report"

            });

            if (matchArtifact.length === 0) {

              console.log('no matching artifact found');

              console.log('result: "skip"');

              return 'skip';

            }

            const download = await github.rest.actions.downloadArtifact({

               owner: context.repo.owner,

               repo: context.repo.repo,

               artifact_id: matchArtifact[0].id,

               archive_format: 'zip',

            });

            fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/code-size-report.zip`, Buffer.from(download.data));

            console.log('artifact downloaded to `code-size-report.zip`');

            console.log('result: "ok"');

            return 'ok';

      - name: 'Unzip artifact'

        if: steps.download-artifact.outputs.result == 'ok'

        run: unzip code-size-report.zip

      - name: Post comment to pull request

        if: steps.download-artifact.outputs.result == 'ok'

        uses: actions/github-script@v6

        with:

          github-token: ${{secrets.GITHUB_TOKEN}}

          script: |

            const fs = require('fs');

            const prNumber = Number(fs.readFileSync('pr_number'));

            const codeSizeReport = `Code size report:

            \`\`\`

            ${fs.readFileSync('diff')}

            \`\`\`

            `;

            const comments = await github.paginate(

              github.rest.issues.listComments,

              {

                owner: context.repo.owner,

                repo: context.repo.repo,

                issue_number: prNumber,

              }

            );

            comments.reverse();

            const previousComment = comments.find(comment =>

              comment.user.login === 'github-actions[bot]'

            )

            // if github-actions[bot] already made a comment, update it,

            // otherwise create a new comment.

            if (previousComment) {

              await github.rest.issues.updateComment({

                owner: context.repo.owner,

                repo: context.repo.repo,

                comment_id: previousComment.id,

                body: codeSizeReport,

              });

            } else {

              await github.rest.issues.createComment({

                owner: context.repo.owner,

                repo: context.repo.repo,

                issue_number: prNumber,

                body: codeSizeReport,

              });

            }

name: Check commit message formatting

on: [push, pull_request]

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

      with:

        fetch-depth: '100'

    - uses: actions/setup-python@v4

    - name: Check commit message formatting

      run: source tools/ci.sh && ci_commit_formatting_run

name: Build docs

on:

  pull_request:

    paths:

      - docs/**

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

    - uses: actions/setup-python@v4

    - name: Install Python packages

      run: pip install Sphinx

    - name: Build docs

      run: make -C docs/ html

name: Check examples

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'examples/**'

      - 'ports/unix/**'

      - 'py/**'

      - 'shared/**'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  embedding:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

    - name: Build

      run: make -C examples/embedding -f micropython_embed.mk && make -C examples/embedding

    - name: Run

      run: ./examples/embedding/embed | grep "hello world"

name: Package mpremote

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'tools/**'

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

      with:

        # Version is determined from git,

        # should be deep enough to get to latest tag

        fetch-depth: '1000'

    - run: |

        git fetch --prune --unshallow --tags

    - uses: actions/setup-python@v4

    - name: Install build tools

      run: pip install build

    - name: Build mpremote wheel

      run: cd tools/mpremote && python -m build --wheel

    - name: Archive mpremote wheel

      uses: actions/upload-artifact@v3

      with:

        name: mpremote

        path: |

          tools/mpremote/dist/mpremote*.whl

name: .mpy file format and tools

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'examples/**'

      - 'tests/**'

      - 'tools/**'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  test:

    runs-on: ubuntu-20.04 # use 20.04 to get python2

    steps:

    - uses: actions/checkout@v3

    - name: Install packages

      run: source tools/ci.sh && ci_mpy_format_setup

    - name: Test mpy-tool.py

      run: source tools/ci.sh && ci_mpy_format_test

name: Build ports metadata

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'tools/**'

      - ports/**

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

    - name: Build ports download metadata

      run: mkdir boards && ./tools/autobuild/build-downloads.py . ./boards

name: cc3200 port

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'tools/**'

      - 'py/**'

      - 'extmod/**'

      - 'shared/**'

      - 'lib/**'

      - 'drivers/**'

      - 'ports/cc3200/**'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

    - name: Install packages

      run: source tools/ci.sh && ci_cc3200_setup

    - name: Build

      run: source tools/ci.sh && ci_cc3200_build

name: esp32 port

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'tools/**'

      - 'py/**'

      - 'extmod/**'

      - 'shared/**'

      - 'lib/**'

      - 'drivers/**'

      - 'ports/esp32/**'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  build_idf402:

    runs-on: ubuntu-20.04

    steps:

    - uses: actions/checkout@v3

    - name: Install packages

      run: source tools/ci.sh && ci_esp32_idf402_setup

    - name: Build

      run: source tools/ci.sh && ci_esp32_build

  build_idf44:

    runs-on: ubuntu-20.04

    steps:

    - uses: actions/checkout@v3

    - name: Install packages

      run: source tools/ci.sh && ci_esp32_idf44_setup

    - name: Build

      run: source tools/ci.sh && ci_esp32_build

name: esp8266 port

on:

  push:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

      - 'tools/**'

      - 'py/**'

      - 'extmod/**'

      - 'shared/**'

      - 'lib/**'

      - 'drivers/**'

      - 'ports/esp8266/**'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true