Merge pull request #142 from PixelgenTechnologies/dev

Release 0.17.0

.dockerignore

@@ -9,6 +9,7 @@ conda-recipe
 
 # Dockerfiles
 *.Dockerfile
+containers/*.Dockerfile
 
 # Editors
 .idea

.editorconfig

@@ -19,7 +19,7 @@ charset = utf-8
 end_of_line = lf
 
 [*.json]
-indent_size = 2
+indent_size = 4
 
 [*.bat]
 indent_style = tab

.gitattributes

@@ -1 +1,2 @@
-src/pixelator/report/webreport/template.html linguist-vendored
+src/pixelator/report/qcreport/template.html linguist-vendored
+tests/snapshots/test_plot/*.png filter=lfs diff=lfs merge=lfs -text

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,21 +1,15 @@
 <!--
-# Pixelgen Technologies pull request template
-
-Many thanks for contributing to it if you think it could be improved. This is a self-improving process!
 
 Please fill in the appropriate checklist below (delete whatever is not relevant).
-These are the most common things requested on pull requests (PRs).
-
-Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.
 
 Learn more about contributing: [CONTRIBUTING.md](https://github.com/PixelgenTechnologies/pixelator/blob/main/CONTRIBUTING.md)
 -->
 
 ## Description
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+Please include a summary of the change and which issue(s) have been fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
 
-Fixes # (issue)
+Fixes: #(issue number)
 
 ## Type of change
 
@@ -28,33 +22,15 @@ Please delete options that are not relevant.
 
 ## How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
-
-- [ ] Test A
-- [ ] Test B
-
-**Test Configuration**:
-* Firmware version:
-* Hardware:
-* Toolchain:
-* SDK:
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce it when relevant.
 
 ## PR checklist:
 
 - [ ] This comment contains a description of changes (with reason).
-- [ ] My code follows the style guidelines of this project
-- [ ] Make sure your code lints, is well-formatted and type checks
 - [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
 - [ ] My changes generate no new warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] If you've added a new stage - have you followed the pipeline CLI conventions in the [USAGE guide](../USAGE.md)
-- [ ] [README.md](./README.md) is updated
-- [ ] If a new tool or package is included, update poetry.lock, [the conda recipe](../conda-recipe/pixelator/meta.yaml) and [cited it properly](../CITATIONS.md)
-- [ ] Include any new [authors/contributors](../AUTHORS.md)
-- [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] If a new tool or package is included, I have updated poetry.lock, and [cited it properly](../CITATIONS.md)
 - [ ] I have checked my code and documentation and corrected any misspellings
-- [ ] Usage Documentation is updated
-- [ ] If you are doing a [release](../RELEASING.md#Releasing), or a significant change to the code, update [CHANGELOG.md](../CHANGELOG.md)
+- [ ] I have documented any significant changes to the code in [CHANGELOG.md](../CHANGELOG.md)

.github/actions/build-dev-image/action.yml

@@ -18,16 +18,13 @@ outputs:
   tags:
     description: "All tags that were pushed"
     value: ${{ steps.meta.outputs.tags }}
-  dev-tag:
-    description: "The dev tag that was pushed"
-    value: ${{ steps.build_input_options.outputs.dev-tag }}
 
 runs:
   using: "composite"
   steps:
     - name: Docker meta
       id: meta
-      uses: docker/metadata-action@v4
+      uses: docker/metadata-action@v5
       with:
         images: |
           ghcr.io/pixelgentechnologies/pixelator
@@ -41,13 +38,11 @@ runs:
 
     - name: Build input options
       id: build_input_options
-      uses: actions/github-script@v6
+      uses: actions/github-script@v7
       with:
         script: |
           const shaShort = context.sha.substring(0, 7)
           const inputParams = ${{ toJSON(inputs) }}
-          const meta = ${{ steps.meta.outputs.json }}
-          const tags = meta["tags"]
 
           const cacheFromArray = inputParams["cache-from"].split('\n').map((line) => line.trim())
             .filter((line) => line !== "")
@@ -57,29 +52,26 @@ runs:
             .filter((line) => line !== "")
             .map((line) => "*.cache-to=" + line)
 
-          const tagsArray = tags.map((tag) => "*.tags=" + tag)
-
           const platformArray = inputParams["platforms"].split(',').map((line) => line.trim())
             .filter((line) => line !== "")
             .map((line) => "*.platform=" + line)
 
           let bakeSetCommands = []
-          bakeSetCommands.push(...tagsArray)
           bakeSetCommands.push(...cacheFromArray)
           bakeSetCommands.push(...cacheToArray)
           bakeSetCommands.push(...platformArray)
 
-          const gitSHAtag = tagsArray.find((tag) => tag.includes('ghcr') && tag.includes('sha'))
-
           bakeSetCommandsText = bakeSetCommands.join('\n')
           core.setOutput('set', bakeSetCommandsText)
-          core.setOutput('dev-tag', gitSHAtag)
-
 
     - name: Build and push to ghcr and ecr
-      uses: docker/bake-action@v3
+      uses: docker/bake-action@v4
       with:
+        files: |
+          ./docker-bake.hcl
+          ${{ steps.meta.outputs.bake-file }}
+
         push: true
-        targets: pixelator-prod
+        targets: pixelator-prod-ci
         provenance: false
         set: ${{ steps.build_input_options.outputs.set }}

.github/workflows/build.yml

@@ -49,7 +49,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - name: Set up build environment
         id: setup_build_env

.github/workflows/checks.yml

@@ -51,16 +51,13 @@ jobs:
     if: needs.pre_job.outputs.paths_result == '{}' || !fromJSON(needs.pre_job.outputs.paths_result).python.should_skip
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python environment
         uses: ./.github/actions/setup-python
         with:
           python-version: "3.11"
 
-      - name: flake8 linter
-        uses: py-actions/flake8@v2
-
       - name: ruff linter
         uses: chartboost/ruff-action@v1
 
@@ -70,31 +67,28 @@ jobs:
     if: needs.pre_job.outputs.should_skip != 'true' || !fromJSON(needs.pre_job.outputs.paths_result).python.should_skip
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Check code lints with Black
-        uses: psf/black@stable
+      - name: ruff formatter
+        uses: chartboost/ruff-action@v1
         with:
-          version: 23.12.0
+          args: "format --check"
 
       # If the above check failed, post a comment on the PR explaining the failure
       - name: Post PR comment
         if: failure()
         uses: mshick/add-pr-comment@v1
         with:
           message: |
-            ## Python linting (`black`) is failing
+            ## Python linting (`ruff format`) is failing
 
             To keep the code consistent with lots of contributors, we run automated code consistency checks.
             To fix this CI test, please run:
 
-            * Install [`black`](https://black.readthedocs.io/en/stable/): `pip install black`
-            * Fix formatting errors in your pipeline: `black .`
+            * `task format`
 
             Once you push these changes the test should pass, and you can hide this comment :+1:
 
-            We highly recommend setting up Black in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!
-
             Thanks again for your contribution!
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           allow-repeats: false
@@ -106,7 +100,7 @@ jobs:
     if: needs.pre_job.outputs.should_skip != 'true' || !fromJSON(needs.pre_job.outputs.paths_result).python.should_skip
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python environment
         uses: ./.github/actions/setup-python

.github/workflows/docs.yml

@@ -51,7 +51,7 @@ jobs:
     if: needs.pre_job.outputs.should_skip == '{}' || !fromJSON(needs.pre_job.outputs.paths_result).main.should_skip
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python environment
         uses: ./.github/actions/setup-python