Updating script, and running to pin README.md and other files (#28030)

* Updating script, and running to pin readmes and files * Restyled by shfmt * Fixing build script * Fixing restyled to ignore this * Fixing path * Restyled by shellharden * Restyled by shfmt * Fixing restyle * Testing this ignore * Correct patch --------- Co-authored-by: Restyled.io <[email protected]>
project-chip · Jul 19, 2023 · 3c75ed0 · 3c75ed0
1 parent 85db1da
commit 3c75ed0
Show file tree

Hide file tree

Showing 30 changed files with 162 additions and 74 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -29,7 +29,7 @@ jobs:
         if: github.actor != 'restyled-io[bot]'
 
         container:
-            image: ghcr.io/project-chip/chip-build:0.8
+            image: ghcr.io/project-chip/chip-build:1
 
         steps:
             - name: Checkout

diff --git a/.github/workflows/roll_and_build_docker.yaml b/.github/workflows/roll_and_build_docker.yaml
@@ -8,7 +8,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Roll docker versions
-        run: ./scripts/helpers/roll_docker_version.sh ./integrations/docker/images/base/chip-build/version
+        run: ./scripts/helpers/roll_docker_version.sh --reason="Automated roll by GitHub Action"
       - uses: EndBug/add-and-commit@v9
         with:
           default_author: github_actions

diff --git a/.restyled.yaml b/.restyled.yaml
@@ -81,11 +81,11 @@ exclude:
     - "src/controller/java/generated/java/**/*" # not formatted: generated files
     - "src/controller/java/zap-generated/**/*" # not formatted: generated files
     - "scripts/setup/bootstrap.sh" # tries to quote loop variable
-
+    - "integrations/docker/build-all.sh" # tries to quote loop variable
 
 changed_paths:
-  maximum: 100000
-  outcome: error
+    maximum: 100000
+    outcome: error
 
 # Restylers to run, and how
 restylers:
@@ -220,21 +220,21 @@ restylers:
           - "**/*.sh"
           - "**/*.bash"
     - name: autopep8
-      image: 'restyled/restyler-autopep8:v2.0.0'
+      image: restyled/restyler-autopep8:v2.0.0
       command:
-        - autopep8
-        - '--in-place'
+          - autopep8
+          - "--in-place"
       arguments: []
       include:
-        - '**/*.py'
+          - "**/*.py"
       interpreters:
-        - python
+          - python
     - name: isort
-      image: 'restyled/restyler-isort:v5.11.2'
+      image: restyled/restyler-isort:v5.11.2
       command:
-        - isort
+          - isort
       arguments: []
       include:
-        - '**/*.py'
+          - "**/*.py"
       interpreters:
-        - python
+          - python
diff --git a/examples/all-clusters-app/ameba/README.md b/examples/all-clusters-app/ameba/README.md
@@ -27,11 +27,11 @@ The CHIP demo application is supported on
 
 -   Pull docker image:
 
-          $ docker pull ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker pull ghcr.io/project-chip/chip-build-ameba:1
 
 -   Run docker container:
 
-          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:1
 
 -   Setup build environment:
 

diff --git a/examples/all-clusters-app/telink/Readme.md b/examples/all-clusters-app/telink/Readme.md
@@ -11,13 +11,13 @@ creating your own application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/all-clusters-minimal-app/ameba/README.md b/examples/all-clusters-minimal-app/ameba/README.md
@@ -27,13 +27,13 @@ The CHIP demo application is supported on
 -   Pull docker image:
 
           ```
-          $ docker pull ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker pull ghcr.io/project-chip/chip-build-ameba:1
           ```
 
 -   Run docker container:
 
           ```
-          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:1
           ```
 
 -   Setup build environment:

diff --git a/examples/all-clusters-minimal-app/telink/Readme.md b/examples/all-clusters-minimal-app/telink/Readme.md
@@ -11,13 +11,13 @@ for creating your own application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/bridge-app/telink/README.md b/examples/bridge-app/telink/README.md
@@ -88,13 +88,13 @@ defined:
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/chef/README.md b/examples/chef/README.md
@@ -101,7 +101,7 @@ relevant platform image. You can simulate the workflow locally by mounting your
 CHIP repo into a container and executing the CI command:
 
 ```shell
-docker run -it --mount source=$(pwd),target=/workspace,type=bind ghcr.io/project-chip/chip-build-$PLATFORM:$VERSION
+docker run -it --mount source=$(pwd),target=/workspace,type=bind ghcr.io/project-chip/chip-build-$PLATFORM:1$VERSION
 ```
 
 In the container:
@@ -128,7 +128,7 @@ chef_$PLATFORM:
     if: github.actor != 'restyled-io[bot]'
 
     container:
-        image: ghcr.io/project-chip/chip-build-$PLATFORM:$VERSION
+        image: ghcr.io/project-chip/chip-build-$PLATFORM:1$VERSION
         options: --user root
 
     steps:
@@ -183,7 +183,7 @@ command for these targets.
 To test your configuration locally, you may employ a similar strategy as in CI:
 
 ```shell
-docker run -it --mount source=$(pwd),target=/workspace,type=bind ghcr.io/project-chip/chip-build-vscode:$VERSION
+docker run -it --mount source=$(pwd),target=/workspace,type=bind ghcr.io/project-chip/chip-build-vscode:1$VERSION
 ```
 
 In the container:

diff --git a/examples/contact-sensor-app/telink/README.md b/examples/contact-sensor-app/telink/README.md
@@ -9,13 +9,13 @@ You can use this example as a reference for creating your own application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/light-switch-app/ameba/README.md b/examples/light-switch-app/ameba/README.md
@@ -26,11 +26,11 @@ The CHIP demo application is supported on
 
 -   Pull docker image:
 
-          $ docker pull ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker pull ghcr.io/project-chip/chip-build-ameba:1
 
 -   Run docker container:
 
-          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:1
 
 -   Setup build environment:
 

diff --git a/examples/light-switch-app/telink/README.md b/examples/light-switch-app/telink/README.md
@@ -14,13 +14,13 @@ creating your own application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/lighting-app/ameba/README.md b/examples/lighting-app/ameba/README.md
@@ -23,11 +23,11 @@ The CHIP demo application is supported on
 
 -   Pull docker image:
 
-          $ docker pull ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker pull ghcr.io/project-chip/chip-build-ameba:1
 
 -   Run docker container:
 
-          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:1
 
 -   Setup build environment:
 

diff --git a/examples/lighting-app/qpg/README.md b/examples/lighting-app/qpg/README.md
diff --git a/examples/lighting-app/qpg/README.md b/examples/lighting-app/qpg/README.md
@@ -0,0 +1,15 @@
+---
+orphan: true
+---
+
+# Matter QPG6105 SDK
+
+## Qorvo SDK
+
+More detailed information on the Qorvo SDK can be found in the
+[Qorvo Matter SDK](https://github.com/Qorvo/QMatter).
+
+## More information
+
+For more information on our product line and support options, please visit
+[www.qorvo.com](https://www.qorvo.com) or contact us at <[email protected]>
diff --git a/examples/lighting-app/telink/README.md b/examples/lighting-app/telink/README.md
@@ -12,13 +12,13 @@ a reference for creating your own application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/lock-app/qpg/README.md b/examples/lock-app/qpg/README.md
diff --git a/examples/lock-app/qpg/README.md b/examples/lock-app/qpg/README.md
@@ -0,0 +1,15 @@
+---
+orphan: true
+---
+
+# Matter QPG6105 SDK
+
+## Qorvo SDK
+
+More detailed information on the Qorvo SDK can be found in the
+[Qorvo Matter SDK](https://github.com/Qorvo/QMatter).
+
+## More information
+
+For more information on our product line and support options, please visit
+[www.qorvo.com](https://www.qorvo.com) or contact us at <[email protected]>
diff --git a/examples/lock-app/telink/README.md b/examples/lock-app/telink/README.md
@@ -12,13 +12,13 @@ a reference for creating your own application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/ota-requestor-app/ameba/README.md b/examples/ota-requestor-app/ameba/README.md
@@ -6,11 +6,11 @@ A prototype application that demonstrates OTA Requestor capabilities.
 
 -   Pull docker image:
 
-          $ docker pull ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker pull ghcr.io/project-chip/chip-build-ameba:1
 
 -   Run docker container:
 
-          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:1
 
 -   Setup build environment:
 

diff --git a/examples/ota-requestor-app/telink/Readme.md b/examples/ota-requestor-app/telink/Readme.md
@@ -5,13 +5,13 @@
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/persistent-storage/qpg/README.md b/examples/persistent-storage/qpg/README.md
diff --git a/examples/persistent-storage/qpg/README.md b/examples/persistent-storage/qpg/README.md
@@ -0,0 +1,15 @@
+---
+orphan: true
+---
+
+# Matter QPG6105 SDK
+
+## Qorvo SDK
+
+More detailed information on the Qorvo SDK can be found in the
+[Qorvo Matter SDK](https://github.com/Qorvo/QMatter).
+
+## More information
+
+For more information on our product line and support options, please visit
+[www.qorvo.com](https://www.qorvo.com) or contact us at <[email protected]>
diff --git a/examples/pigweed-app/ameba/README.md b/examples/pigweed-app/ameba/README.md
@@ -31,11 +31,11 @@ following features are available:
 
 -   Pull docker image:
 
-          $ docker pull ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker pull ghcr.io/project-chip/chip-build-ameba:1
 
 -   Run docker container:
 
-          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:latest
+          $ docker run -it -v ${CHIP_DIR}:/root/chip ghcr.io/project-chip/chip-build-ameba:1
 
 -   Setup build environment:
 

diff --git a/examples/pump-app/telink/README.md b/examples/pump-app/telink/README.md
@@ -13,13 +13,13 @@ reference for creating your own pump application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay

diff --git a/examples/pump-controller-app/telink/README.md b/examples/pump-controller-app/telink/README.md
@@ -14,13 +14,13 @@ your own pump application.
 1. Pull docker image from repository:
 
     ```bash
-    $ docker pull ghcr.io/project-chip/chip-build-telink:latest
+    $ docker pull ghcr.io/project-chip/chip-build-telink:1
     ```
 
 1. Run docker container:
 
     ```bash
-    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:latest
+    $ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" ghcr.io/project-chip/chip-build-telink:1
     ```
 
     here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay