.github/workflows/checkbox-core-snap-beta-release.yml

@@ -20,17 +20,13 @@ jobs:
     name: Checkbox core snap for series${{ matrix.releases }}
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Copy over the common files for series${{ matrix.releases }}
         run: |
           cd checkbox-core-snap/
+          sudo apt update && sudo apt install -qq -y python3-setuptools-scm
           ./prepare.sh $SERIES
-      - name: Remove '.dev' suffix from the version name
-        run: |
-          cd checkbox-core-snap
-          # in the following sed onliner the '0,/^version/' bit specifies the range
-          # of lines it should act upon, this way only the first occurence of '^version'
-          # is getting affected.
-          sed -i '0,/^version/s/\(^version\:.*\).dev/\1/' $SERIES/snap/snapcraft.yaml
       - name: add LP credentials
         run: |
           mkdir -p ~/.local/share/snapcraft/provider/launchpad/
@@ -44,9 +40,12 @@ jobs:
           snapcraft-channel: 7.x/stable
           snapcraft-args: remote-build --build-on amd64,arm64,armhf,i386 --launchpad-accept-public-upload
       - uses: actions/upload-artifact@v3
+        if: failure()
         with:
           name: snapcraft-log-series${{ matrix.releases }}
-          path: /home/runner/.cache/snapcraft/log
+          path: |
+            /home/runner/.cache/snapcraft/log/
+            /home/runner/.local/state/snapcraft/log/
       - uses: actions/upload-artifact@v3
         with:
           name: series${{ matrix.releases }}

.github/workflows/checkbox-core-snap-daily-builds.yml

@@ -40,18 +40,13 @@ jobs:
     name: Checkbox Core snap for series ${{ matrix.releases }}
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Copy over the common files for series ${{ matrix.releases }}
         run: |
           cd checkbox-core-snap/
+          sudo apt update && sudo apt install -qq -y python3-setuptools-scm
           ./prepare.sh $SERIES
-      - name: Add git short sha suffix to the version name
-        run: |
-          cd checkbox-core-snap
-          # in the following sed onliner the '0,/^version/' bit specifies the range
-          # of lines it should act upon, this way only the first occurence of '^version'
-          # is getting affected.
-          sed -i '0,/^version/s/\(^version\:.*\).dev/\1/' $SERIES/snap/snapcraft.yaml
-          sed -i "0,/^version/s/\(^version\:.*\)'/\1+git$(git rev-parse --short HEAD)'/" $SERIES/snap/snapcraft.yaml
       - name: add LP credentials
         run: |
           mkdir -p ~/.local/share/snapcraft/provider/launchpad/
@@ -65,9 +60,12 @@ jobs:
           snapcraft-channel: 7.x/stable
           snapcraft-args: remote-build --build-on amd64,arm64,armhf,i386 --launchpad-accept-public-upload
       - uses: actions/upload-artifact@v3
+        if: failure()
         with:
           name: snapcraft-log-series${{ matrix.releases }}
-          path: /home/runner/.cache/snapcraft/log
+          path: |
+            /home/runner/.cache/snapcraft/log/
+            /home/runner/.local/state/snapcraft/log/
       - uses: actions/upload-artifact@v3
         with:
           name: series${{ matrix.releases }}

.github/workflows/checkbox-snap-beta-release.yml

@@ -21,17 +21,13 @@ jobs:
     name: Checkbox snap for series ${{ matrix.type }}${{ matrix.releases }}
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Copy over the common files for series ${{ matrix.type }}${{ matrix.releases }}
         run: |
           cd checkbox-snap/
+          sudo apt update && sudo apt install -qq -y python3-setuptools-scm
           ./prepare_${{ matrix.type }}.sh $SERIES
-      - name: Remove '.dev' suffix from the version name
-        run: |
-          cd checkbox-snap
-          # in the following sed onliner the '0,/^version/' bit specifies the range
-          # of lines it should act upon, this way only the first occurence of '^version'
-          # is getting affected.
-          sed -i '0,/^version/s/\(^version\:.*\).dev/\1/' $SERIES/snap/snapcraft.yaml
       - name: add LP credentials
         run: |
           mkdir -p ~/.local/share/snapcraft/provider/launchpad/
@@ -45,9 +41,12 @@ jobs:
           snapcraft-channel: 7.x/stable
           snapcraft-args: remote-build --build-on amd64,arm64,armhf,i386 --launchpad-accept-public-upload
       - uses: actions/upload-artifact@v3
+        if: failure()
         with:
           name: snapcraft-log-series-${{ matrix.type }}${{ matrix.releases }}
-          path: /home/runner/.cache/snapcraft/log
+          path: |
+            /home/runner/.cache/snapcraft/log/
+            /home/runner/.local/state/snapcraft/log/
       - uses: actions/upload-artifact@v3
         with:
           name: series_${{ matrix.type }}${{ matrix.releases }}

.github/workflows/checkbox-snap-daily-builds.yml

@@ -41,18 +41,13 @@ jobs:
     name: Checkbox snap for series ${{ matrix.type }}${{ matrix.releases }}
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Copy over the common files for series ${{ matrix.type }}${{ matrix.releases }}
         run: |
           cd checkbox-snap/
+          sudo apt update && sudo apt install -qq -y python3-setuptools-scm
           ./prepare_${{ matrix.type }}.sh $SERIES
-      - name: Add git short sha suffix to the version name
-        run: |
-          cd checkbox-snap
-          # in the following sed onliner the '0,/^version/' bit specifies the range
-          # of lines it should act upon, this way only the first occurence of '^version'
-          # is getting affected.
-          sed -i '0,/^version/s/\(^version\:.*\).dev/\1/' $SERIES/snap/snapcraft.yaml
-          sed -i "0,/^version/s/\(^version\:.*\)'/\1+git$(git rev-parse --short HEAD)'/" $SERIES/snap/snapcraft.yaml
       - name: add LP credentials
         run: |
           mkdir -p ~/.local/share/snapcraft/provider/launchpad/
@@ -66,9 +61,12 @@ jobs:
           snapcraft-channel: 7.x/stable
           snapcraft-args: remote-build --build-on amd64,arm64,armhf,i386 --launchpad-accept-public-upload
       - uses: actions/upload-artifact@v3
+        if: failure()
         with:
           name: snapcraft-log-series-${{ matrix.type }}${{ matrix.releases }}
-          path: /home/runner/.cache/snapcraft/log
+          path: |
+            /home/runner/.cache/snapcraft/log/
+            /home/runner/.local/state/snapcraft/log/
       - uses: actions/upload-artifact@v3
         with:
           name: series_${{ matrix.type }}${{ matrix.releases }}

.github/workflows/deb-beta-release.yml

@@ -23,6 +23,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           LP_CREDENTIALS: ${{ secrets.LP_CREDS }}
           CHECKBOX_REPO: ${{ github.repository }}
+          PYTHONUNBUFFERED: 1
         run: |
           gh release create $(git describe --tags --abbrev=0 --match v*) -d --generate-notes
           tools/release/release_deb_monorepo.py

.github/workflows/deb-daily-builds.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt update -qq
-          sudo apt install -qq -y python3-launchpadlib
+          sudo apt install -qq -y python3-launchpadlib python3-setuptools-scm
           git clone -b main https://git.launchpad.net/~hook25/ppa-dev-tools /tmp/ppa-dev-tools
       - name: Checkout checkbox monorepo
         uses: actions/checkout@v3
@@ -22,5 +22,6 @@ jobs:
       - name: Check for new commits, push build and wait result
         env:
           LP_CREDENTIALS: ${{ secrets.LP_CREDS }}
+          PYTHONUNBUFFERED: 1
         run: |
           tools/daily-builds/deb_daily_builds.py

.github/workflows/documentation-check.yml

@@ -26,19 +26,18 @@ jobs:
           sudo apt-get install aspell aspell-en
 
       - name: Install the doc framework
+        working-directory: docs/
         run: |
           make install
 
       - name: Build docs and run spelling checker
+        working-directory: docs/
         run: |
           make spelling
 
   woke:
     name: Inclusive language check
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: docs
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -48,6 +47,7 @@ jobs:
         with:
           # Cause the check to fail on any broke rules
           fail-on-error: true
+          workdir: docs/
           woke-args: "*.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"
 
   linkcheck:
@@ -61,9 +61,11 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install the doc framework
+        working-directory: docs/
         run: |
           make install
 
       - name: Run linkchecker
+        working-directory: docs/
         run: |
           make linkcheck

.github/workflows/metabox.yaml

@@ -10,16 +10,17 @@ jobs:
   metabox_run_required:
     runs-on: ubuntu-latest
     name: Check for changes in metabox and checkbox-ng dirs
+    outputs:
+      required_run: ${{ steps.check_diff.outputs.required_run }}
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Use git diff to see if there are any changes in the metabox and checkbox-ng directories
         id: check_diff
-        continue-on-error: true
         run: |
-          git diff --exit-code HEAD origin/main -- checkbox-ng metabox
-          if [[ $? -eq 0 ]]
+          DIFF_LENGTH=`git diff HEAD origin/main -- checkbox-ng metabox | wc -l`
+          if [[ $DIFF_LENGTH -eq 0 ]]
             then
               echo "No Metabox run required."
               echo "required_run=false" >> $GITHUB_OUTPUT
@@ -29,7 +30,7 @@ jobs:
           fi
 
   Metabox:
-    if: (github.event.review.state == 'approved' && needs.metabox_run_required.outputs.required_run == 'true') || github.event_name == 'workflow_dispatch'
+    if: (github.event.review.state == 'approved' && true == fromJSON(needs.metabox_run_required.outputs.required_run)) || github.event_name == 'workflow_dispatch'
     strategy:
       fail-fast: false
       matrix:
@@ -60,8 +61,8 @@ jobs:
           lxc profile device add default root disk path=/ pool=metabox${{ matrix.os }}
           lxc storage list
       - name: Install dependencies
-        run: python3 -m pip install --upgrade pyopenssl
+        run: python3 -m pip install --upgrade pyopenssl pip setuptools
       - name: Install Metabox
         run: python3 -m pip install -e .
       - name: Run Metabox scenarios
-        run: metabox configs/${{ matrix.mode }}-source-${{ matrix.os }}.py --log TRACE
+        run: metabox configs/${{ matrix.mode }}-source-${{ matrix.os }}.py

.github/workflows/tox-provider-iiotg.yaml

@@ -0,0 +1,32 @@
+name: Test Intel IOTG provider with tox
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - providers/iiotg/**
+  pull_request:
+    branches: [ main ]
+    paths:
+      - providers/iiotg/**
+  workflow_dispatch:
+
+jobs:
+  build:
+    defaults:
+      run:
+        working-directory: providers/iiotg
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python: ["3.5", "3.6", "3.8", "3.10"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install tox
+        run: pip install tox
+      - name: Run tox
+        run: tox

.readthedocs.yaml

@@ -10,6 +10,12 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow  || true
+    post_create_environment:
+      - pip install --upgrade pip
+      - pip install checkbox-ng/
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

CONTRIBUTING.md

@@ -56,7 +56,7 @@ Install the Checkbox support library in the virtual environment:
 
 ``` bash
 (venv) $ cd ~/checkbox/checkbox-support
-(venv) $ ./setup.py install
+(venv) $ python3 -m pip install -e .
 ```
 
 You should now be able to run checkbox, select a test plan and run it: