Merge pull request #40 from per1234/rewrite-compile-examples

libraries/compile-examples: rewrite script in Python

Author: aentinger

.github/workflows/libraries_compile-examples.yml

@@ -18,15 +18,18 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install --requirement "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches/requirements.txt"
           pip install --requirement "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends/requirements.txt"
 
       - name: Lint with flake8
         run: |
           pip install --quiet flake8
           pip install --quiet pep8-naming
+          flake8 --show-source "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches"
           flake8 --show-source "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends"
 
       - name: Run Python unit tests
         run: |
-          export PYTHONPATH="$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends"
+          export PYTHONPATH="$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches:$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends"
+          pytest "$GITHUB_WORKSPACE/libraries/compile-examples/compilesketches/tests"
           python -m unittest discover "$GITHUB_WORKSPACE/libraries/compile-examples/reportsizetrends/tests"

Dockerfile

@@ -1,15 +1,14 @@
 FROM python:3.8.2
 
-# Install prerequisites
-RUN apt-get update && apt-get install -y git wget jq curl \
-    && rm -rf /var/lib/apt/lists/*
+ENV PYTHONPATH="/reportsizetrends"
 
 # Copies your code file from your action repository to the filesystem path `/` of the container
-COPY entrypoint.sh /entrypoint.sh
+COPY compilesketches /compilesketches
 COPY reportsizetrends /reportsizetrends
 
 # Install python dependencies
+RUN pip install -r /compilesketches/requirements.txt
 RUN pip install -r /reportsizetrends/requirements.txt
 
 # Code file to execute when the docker container starts up (`entrypoint.sh`)
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["python", "/compilesketches/compilesketches.py"]

README.md

@@ -24,6 +24,10 @@ List of library dependencies to install (space separated). Default `""`.
 
 List of paths containing sketches to compile. These paths will be searched recursively. Default `"examples"`.
 
+### `verbose`
+
+Set to true to show verbose output in the log. Default `false`
+
 ### `github-token`
 
 GitHub access token used to get information from the GitHub API. Only needed if you're using the size report features with private repositories. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.

action.yml

@@ -13,6 +13,9 @@ inputs:
   sketch-paths:
     description: 'List of paths containing sketches to compile.'
     default: 'examples'
+  verbose:
+    description: 'Set to true to show verbose output in the log'
+    default: false
   github-token:
     description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the size report features with private repositories.'
     default: ''
@@ -40,15 +43,3 @@ inputs:
 runs:
   using: 'docker'
   image: 'Dockerfile'
-  args:
-    - ${{ inputs.cli-version }}
-    - ${{ inputs.fqbn }}
-    - ${{ inputs.libraries }}
-    - ${{ inputs.sketch-paths }}
-    - ${{ inputs.github-token }}
-    - ${{ inputs.size-report-sketch }}
-    - ${{ inputs.enable-size-deltas-report }}
-    - ${{ inputs.size-deltas-report-folder-name }}
-    - ${{ inputs.enable-size-trends-report }}
-    - ${{ inputs.size-trends-report-spreadsheet-id }}
-    - ${{ inputs.size-trends-report-sheet-name }}

compilesketches/.flake8

@@ -0,0 +1,7 @@
+[flake8]
+doctests = True
+# W503 and W504 are mutually exclusive. PEP 8 recommends line break before.
+ignore = W503
+max-complexity = 10
+max-line-length = 120
+select = E,W,F,C,N