From fc1f4f5aaaf315a443b891ae4eb5885987daabca Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 13:25:14 +0200 Subject: [PATCH 01/10] Refactoring docs workflow --- .github/workflows/ci.yml | 36 +++++++++++++++++++++++------------- src/configuration.rs | 2 +- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7f00033..a7971f7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -93,19 +93,19 @@ jobs: with: ruby-version: 2.7.x - - name: Setup Jekyll - working-directory: docs - run: | - gem update - gem update bundler - gem install jekyll bundler - bundler install + - uses: actions/cache@v2 + with: + path: docs/vendor/bundle + keys: ${{runner.os}}-gems-${{ hashFiles('**/Gemfile.lock') }} + restore-keys: | + ${{ runner.os }}-gems- - uses: actions-rs/toolchain@v1 with: toolchain: stable target: thumbv7em-none-eabihf override: true + - name: Install Deadlinks uses: actions-rs/cargo@v1 with: @@ -126,14 +126,24 @@ jobs: # auto-generated code. args: --dir target/thumbv7em-none-eabihf/doc --ignore-fragments --check-http --check-intra-doc-links - - name: Move firmware documents - run: | - mkdir -p docs/_site/stabilizer + - uses: lemonarc/jekyll-action@1.0.0 + working-directory: docs - - name: Test User Manual + - name: Setup Site working-directory: docs run: | - rake build + mkdir _site/stabilizer + mv _site/* _site/stabilizer mv ../target/thumbv7em-none-eabihf/doc _site/stabilizer/firmware - rake test + - name: Test User Manual + uses: chabad360/htmlproofer@v1.1 + working-directory: docs + with: + directory: "./_site/stabilizer" + arguments: + --assume-extension + --file-ignore "/stabilizer\/firmware\/.*/" + --url-irgnore "/quartiq.de\/stabilizer/" + --allow-hash-href + --typhoeus_config '{"ssl_verify_peer": false}' diff --git a/src/configuration.rs b/src/configuration.rs index 01e410a..228f40e 100644 --- a/src/configuration.rs +++ b/src/configuration.rs @@ -3,7 +3,7 @@ /// MQTT broker IPv4 address /// /// In the default configuration, the IP address is defined as 10.34.16.10. -pub const MQTT_BROKER: [u8; 4] = [10, 34, 16, 10]; +pub const MQTT_BROKER: [u8; 4] = [10, 35, 16, 10]; /// Sampling Frequency /// From fee324fe807e5ef9626a4624d0144e22d112237c Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 13:32:18 +0200 Subject: [PATCH 02/10] Updating steps --- .github/workflows/ci.yml | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a7971f7..24744d2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -126,24 +126,9 @@ jobs: # auto-generated code. args: --dir target/thumbv7em-none-eabihf/doc --ignore-fragments --check-http --check-intra-doc-links - - uses: lemonarc/jekyll-action@1.0.0 - working-directory: docs - - - name: Setup Site + - name: Test Site working-directory: docs run: | - mkdir _site/stabilizer - mv _site/* _site/stabilizer + rake build mv ../target/thumbv7em-none-eabihf/doc _site/stabilizer/firmware - - - name: Test User Manual - uses: chabad360/htmlproofer@v1.1 - working-directory: docs - with: - directory: "./_site/stabilizer" - arguments: - --assume-extension - --file-ignore "/stabilizer\/firmware\/.*/" - --url-irgnore "/quartiq.de\/stabilizer/" - --allow-hash-href - --typhoeus_config '{"ssl_verify_peer": false}' + rake test From 8f6ec3d7e4c08e255566e83d11a4583c937e6378 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 13:33:27 +0200 Subject: [PATCH 03/10] fixing key name --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 24744d2..3f5aedb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -96,7 +96,7 @@ jobs: - uses: actions/cache@v2 with: path: docs/vendor/bundle - keys: ${{runner.os}}-gems-${{ hashFiles('**/Gemfile.lock') }} + key: ${{runner.os}}-gems-${{ hashFiles('**/Gemfile.lock') }} restore-keys: | ${{ runner.os }}-gems- From 820f7665a77bbcda8fd4a32c39854454adc09b76 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 13:48:10 +0200 Subject: [PATCH 04/10] fixing caching --- .github/workflows/ci.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3f5aedb..e3c95ae 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -100,6 +100,13 @@ jobs: restore-keys: | ${{ runner.os }}-gems- + - uses: actions/cache@v2 + with: + path: cargo-cache + key: ${{runner.os}}-cargo + restore-keys: | + ${{runner.os}}-cargo + - uses: actions-rs/toolchain@v1 with: toolchain: stable @@ -110,7 +117,9 @@ jobs: uses: actions-rs/cargo@v1 with: command: install - args: cargo-deadlinks + args: | + --root cargo-cache + cargo-deadlinks - name: cargo doc uses: actions-rs/cargo@v1 @@ -120,6 +129,8 @@ jobs: - name: cargo deadlinks uses: actions-rs/cargo@v1 + env: + PATH: cargo-cache;${{env.PATH}} with: command: deadlinks # We intentionally ignore fragments, as RTIC may generate fragments for various @@ -129,6 +140,10 @@ jobs: - name: Test Site working-directory: docs run: | + # Install depedencies at our cache location + bundle config path vendor/bundle + bundle install + rake build mv ../target/thumbv7em-none-eabihf/doc _site/stabilizer/firmware rake test From 5b949d2492d0e6ab255a1720ca8bfabd86562a43 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 13:55:21 +0200 Subject: [PATCH 05/10] Fixing path --- .github/workflows/ci.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e3c95ae..938670a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -121,6 +121,9 @@ jobs: --root cargo-cache cargo-deadlinks + - name: Update Path + run: echo "./cargo-cache" >> $GITHUB_PATH + - name: cargo doc uses: actions-rs/cargo@v1 with: @@ -129,8 +132,6 @@ jobs: - name: cargo deadlinks uses: actions-rs/cargo@v1 - env: - PATH: cargo-cache;${{env.PATH}} with: command: deadlinks # We intentionally ignore fragments, as RTIC may generate fragments for various From 5cc1c68d507a0d5479bd63ed712fd043abe63933 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 13:56:39 +0200 Subject: [PATCH 06/10] Hashing bins for unique cache key --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 938670a..760c874 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -103,9 +103,9 @@ jobs: - uses: actions/cache@v2 with: path: cargo-cache - key: ${{runner.os}}-cargo + key: ${{runner.os}}-cargo-${{ hashFiles('cargo-cache/bins/*') }} restore-keys: | - ${{runner.os}}-cargo + ${{runner.os}}-cargo- - uses: actions-rs/toolchain@v1 with: From a263835dd24e63e681715ba3af3926bc1e1940a5 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 14:07:09 +0200 Subject: [PATCH 07/10] Simplifying rust cache --- .github/workflows/ci.yml | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 760c874..f9f75c3 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -85,6 +85,7 @@ jobs: args: --package dsp --target=x86_64-unknown-linux-gnu doc: + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -93,6 +94,12 @@ jobs: with: ruby-version: 2.7.x + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + target: thumbv7em-none-eabihf + override: true + - uses: actions/cache@v2 with: path: docs/vendor/bundle @@ -100,30 +107,15 @@ jobs: restore-keys: | ${{ runner.os }}-gems- - - uses: actions/cache@v2 - with: - path: cargo-cache - key: ${{runner.os}}-cargo-${{ hashFiles('cargo-cache/bins/*') }} - restore-keys: | - ${{runner.os}}-cargo- - - - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - target: thumbv7em-none-eabihf - override: true + - uses: Swatinem/rust-cache@v1 - name: Install Deadlinks uses: actions-rs/cargo@v1 with: command: install args: | - --root cargo-cache cargo-deadlinks - - name: Update Path - run: echo "./cargo-cache" >> $GITHUB_PATH - - name: cargo doc uses: actions-rs/cargo@v1 with: From 232a3a8c95082230f0a24cafe5023f7a4c631af0 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 14:40:32 +0200 Subject: [PATCH 08/10] Using bundle version for rake --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f9f75c3..4c18a9c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -137,6 +137,6 @@ jobs: bundle config path vendor/bundle bundle install - rake build + bundle exec rake build mv ../target/thumbv7em-none-eabihf/doc _site/stabilizer/firmware - rake test + bundle exec rake test From 58ceb4f30710fca18c7edd7da917bf0b022d36d6 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 14:51:44 +0200 Subject: [PATCH 09/10] Forcing rerun --- .github/workflows/ci.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4c18a9c..0a8b6e1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -85,7 +85,6 @@ jobs: args: --package dsp --target=x86_64-unknown-linux-gnu doc: - runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 From 51cef9f515cbf6c68fc360790cc2355226fa3253 Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 19 Jul 2021 15:06:57 +0200 Subject: [PATCH 10/10] Update src/configuration.rs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Jördens --- src/configuration.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/configuration.rs b/src/configuration.rs index 228f40e..01e410a 100644 --- a/src/configuration.rs +++ b/src/configuration.rs @@ -3,7 +3,7 @@ /// MQTT broker IPv4 address /// /// In the default configuration, the IP address is defined as 10.34.16.10. -pub const MQTT_BROKER: [u8; 4] = [10, 35, 16, 10]; +pub const MQTT_BROKER: [u8; 4] = [10, 34, 16, 10]; /// Sampling Frequency ///