From 88a08e1063779fe8a098d52eb8752f2e23d474be Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:24:48 +0100 Subject: [PATCH 01/14] Update push trigger branches in docs-and-testcov workflow --- .github/workflows/docs-and-testcov.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 4f81af7..819f278 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -6,7 +6,7 @@ concurrency: on: push: - branches: [main] + branches: [main, fix_docs] # pull_request: # branches: [main] workflow_dispatch: From 9ab3a7c2c1dce2f9dfb7984a3d4fd9b340b6a170 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:39:19 +0100 Subject: [PATCH 02/14] Update branch trigger and fix documentation file handling in workflow --- .github/workflows/docs-and-testcov.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 819f278..00fa53f 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -6,7 +6,7 @@ concurrency: on: push: - branches: [main, fix_docs] + branches: [main, update_docs_workflow] # pull_request: # branches: [main] workflow_dispatch: @@ -96,15 +96,15 @@ jobs: run: | # mkdir docs mkdir -p target/doc/docs - cp -r target/doc/rustframe/* target/doc/docs/ + mv target/doc/rustframe/* target/doc/docs/ mkdir output cp tarpaulin-report.html target/doc/docs/ cp tarpaulin-report.json target/doc/docs/ cp tarpaulin-badge.json target/doc/docs/ cp last-commit-date.json target/doc/docs/ - mkdir -p target/doc/.github - cp .github/rustframe_logo.png target/doc/.github/rustframe_logo.png + mkdir -p target/doc/docs/.github + cp .github/rustframe_logo.png target/doc/docs/.github/ echo "" > target/doc/index.html - name: Upload Pages artifact From 41349e2dba5e398cf1c4b22ef2b543b6e613512b Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:40:27 +0100 Subject: [PATCH 03/14] Update push trigger branch for docs-and-testcov workflow --- .github/workflows/docs-and-testcov.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 00fa53f..630848d 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -6,7 +6,7 @@ concurrency: on: push: - branches: [main, update_docs_workflow] + branches: [main, fix_docs] # pull_request: # branches: [main] workflow_dispatch: From 00befe7ee488e456dd8e2df49f85b42b449a1fa8 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:44:17 +0100 Subject: [PATCH 04/14] Fix file path for rustframe logo in documentation output --- .github/workflows/docs-and-testcov.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 630848d..9d1fb48 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -104,7 +104,7 @@ jobs: cp tarpaulin-badge.json target/doc/docs/ cp last-commit-date.json target/doc/docs/ mkdir -p target/doc/docs/.github - cp .github/rustframe_logo.png target/doc/docs/.github/ + cp .github/rustframe_logo.png target/doc/docs/.github/rustframe_logo.png echo "" > target/doc/index.html - name: Upload Pages artifact @@ -115,4 +115,4 @@ jobs: - name: Deploy to GitHub Pages # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' - uses: actions/deploy-pages@v4 \ No newline at end of file + uses: actions/deploy-pages@v4 From 76b8824ce34ef56757b4ffc71b1a9db85e3a5c66 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:49:07 +0100 Subject: [PATCH 05/14] Refactor documentation file copying to include entire .github directory --- .github/workflows/docs-and-testcov.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 9d1fb48..dfd4da4 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -104,7 +104,7 @@ jobs: cp tarpaulin-badge.json target/doc/docs/ cp last-commit-date.json target/doc/docs/ mkdir -p target/doc/docs/.github - cp .github/rustframe_logo.png target/doc/docs/.github/rustframe_logo.png + cp -r .github target/doc/docs/ echo "" > target/doc/index.html - name: Upload Pages artifact From 7c96439550b76e9bd1abe33e4f82d355cb10cc3b Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:53:16 +0100 Subject: [PATCH 06/14] Fix .github directory path in documentation output and add verification step --- .github/workflows/docs-and-testcov.yml | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index dfd4da4..b536aae 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -103,10 +103,17 @@ jobs: cp tarpaulin-report.json target/doc/docs/ cp tarpaulin-badge.json target/doc/docs/ cp last-commit-date.json target/doc/docs/ - mkdir -p target/doc/docs/.github - cp -r .github target/doc/docs/ + cp -r .github target/doc/docs/.github echo "" > target/doc/index.html + # verify that .github exists in the output directory + - name: Verify .github directory + run: | + if [ ! -d target/doc/docs/.github ]; then + echo ".github directory not found in output!" + exit 1 + fi + - name: Upload Pages artifact # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' uses: actions/upload-pages-artifact@v3 From 29c304d512b1ad102bab88344c19da10928eb077 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:00:51 +0100 Subject: [PATCH 07/14] testing changes --- .github/workflows/docs-and-testcov.yml | 46 +++++++++++--------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index b536aae..8e9bb2a 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -6,9 +6,9 @@ concurrency: on: push: - branches: [main, fix_docs] - # pull_request: - # branches: [main] + branches: [main] +# pull_request: +# branches: [main] workflow_dispatch: permissions: @@ -27,9 +27,9 @@ jobs: - id: choose uses: ./.github/actions/runner-fallback with: - primary-runner: "self-hosted" + primary-runner: "self-hosted,ubuntu-latest" fallback-runner: "ubuntu-latest" - github-token: ${{ secrets.CUSTOM_GH_TOKEN }} + github-token: ${{ secrets.GITHUB_TOKEN }} docs-and-testcov: needs: pick-runner @@ -94,32 +94,26 @@ jobs: - name: Copy files to output directory run: | - # mkdir docs - mkdir -p target/doc/docs - mv target/doc/rustframe/* target/doc/docs/ - mkdir output - cp tarpaulin-report.html target/doc/docs/ - cp tarpaulin-report.json target/doc/docs/ - cp tarpaulin-badge.json target/doc/docs/ - cp last-commit-date.json target/doc/docs/ - cp -r .github target/doc/docs/.github - echo "" > target/doc/index.html + cp tarpaulin-report.html target/doc/rustframe/ + cp tarpaulin-report.json target/doc/rustframe/ + cp tarpaulin-badge.json target/doc/rustframe/ + cp last-commit-date.json target/doc/rustframe/ + mkdir -p target/doc/rustframe/.github + # cp .github/rustframe_logo.png target/doc/rustframe/.github/ + cp .github/rustframe_logo.png target/doc/rustframe/.github/ + + mkdir docs + mv target/doc/rustframe/* docs/ - # verify that .github exists in the output directory - - name: Verify .github directory - run: | - if [ ! -d target/doc/docs/.github ]; then - echo ".github directory not found in output!" - exit 1 - fi + echo "" > docs/index.html - name: Upload Pages artifact - # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' + if: github.event_name == 'push' uses: actions/upload-pages-artifact@v3 with: - path: target/doc/ + path: docs/ - name: Deploy to GitHub Pages - # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' - uses: actions/deploy-pages@v4 + if: github.event_name == 'push' + uses: actions/deploy-pages@v4 \ No newline at end of file From eb09593b0a3fd4e546f4541f018f735164e92fa7 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:01:36 +0100 Subject: [PATCH 08/14] Update push trigger branches for docs-and-testcov workflow --- .github/workflows/docs-and-testcov.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 8e9bb2a..727e9d7 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -6,7 +6,7 @@ concurrency: on: push: - branches: [main] + branches: [main, fix_docs] # pull_request: # branches: [main] workflow_dispatch: From d670ab4a5c46fda5bd1f88cd948fda383b5d1de8 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 02:53:16 +0100 Subject: [PATCH 09/14] Fix .github directory path in documentation output and add verification step --- .github/workflows/docs-and-testcov.yml | 46 +++++++++++++++----------- 1 file changed, 26 insertions(+), 20 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 727e9d7..b536aae 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -7,8 +7,8 @@ concurrency: on: push: branches: [main, fix_docs] -# pull_request: -# branches: [main] + # pull_request: + # branches: [main] workflow_dispatch: permissions: @@ -27,9 +27,9 @@ jobs: - id: choose uses: ./.github/actions/runner-fallback with: - primary-runner: "self-hosted,ubuntu-latest" + primary-runner: "self-hosted" fallback-runner: "ubuntu-latest" - github-token: ${{ secrets.GITHUB_TOKEN }} + github-token: ${{ secrets.CUSTOM_GH_TOKEN }} docs-and-testcov: needs: pick-runner @@ -94,26 +94,32 @@ jobs: - name: Copy files to output directory run: | - mkdir output - cp tarpaulin-report.html target/doc/rustframe/ - cp tarpaulin-report.json target/doc/rustframe/ - cp tarpaulin-badge.json target/doc/rustframe/ - cp last-commit-date.json target/doc/rustframe/ - mkdir -p target/doc/rustframe/.github - # cp .github/rustframe_logo.png target/doc/rustframe/.github/ - cp .github/rustframe_logo.png target/doc/rustframe/.github/ - - mkdir docs - mv target/doc/rustframe/* docs/ + # mkdir docs + mkdir -p target/doc/docs + mv target/doc/rustframe/* target/doc/docs/ - echo "" > docs/index.html + mkdir output + cp tarpaulin-report.html target/doc/docs/ + cp tarpaulin-report.json target/doc/docs/ + cp tarpaulin-badge.json target/doc/docs/ + cp last-commit-date.json target/doc/docs/ + cp -r .github target/doc/docs/.github + echo "" > target/doc/index.html + + # verify that .github exists in the output directory + - name: Verify .github directory + run: | + if [ ! -d target/doc/docs/.github ]; then + echo ".github directory not found in output!" + exit 1 + fi - name: Upload Pages artifact - if: github.event_name == 'push' + # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' uses: actions/upload-pages-artifact@v3 with: - path: docs/ + path: target/doc/ - name: Deploy to GitHub Pages - if: github.event_name == 'push' - uses: actions/deploy-pages@v4 \ No newline at end of file + # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' + uses: actions/deploy-pages@v4 From 6bb1c2a0deaf96ad5079cc69c30faf4fd672148f Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:18:22 +0100 Subject: [PATCH 10/14] testing w .nojekyll --- .github/workflows/docs-and-testcov.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index b536aae..60853e2 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -103,8 +103,9 @@ jobs: cp tarpaulin-report.json target/doc/docs/ cp tarpaulin-badge.json target/doc/docs/ cp last-commit-date.json target/doc/docs/ - cp -r .github target/doc/docs/.github + cp -r .github target/doc/docs echo "" > target/doc/index.html + touch target/doc/.nojekyll # verify that .github exists in the output directory - name: Verify .github directory From 2e6c4bd6bbfc1f5046de296ccd779c6578fd04e0 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:26:25 +0100 Subject: [PATCH 11/14] Add step to replace logo URL in README.md during workflow --- .github/workflows/docs-and-testcov.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 60853e2..b2939ae 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -44,6 +44,14 @@ jobs: toolchain: stable override: true + - name: Replace logo URL in README.md + env: + LOGO_URL: ${{ secrets.LOGO_URL }} + run: | + # replace with EXAMPLE.COM/LOGO + + sed -i 's|.github/rustframe_logo.png|${{ env.LOGO_URL }}|g' README.md + - name: Build documentation run: cargo doc --no-deps --release From 38baf0c648c1f16e0cf9ed0db36cea637d2cb3c0 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:30:58 +0100 Subject: [PATCH 12/14] Fix logo URL replacement in README.md and adjust documentation copying step --- .github/workflows/docs-and-testcov.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index b2939ae..ff6c445 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -50,7 +50,7 @@ jobs: run: | # replace with EXAMPLE.COM/LOGO - sed -i 's|.github/rustframe_logo.png|${{ env.LOGO_URL }}|g' README.md + sed -i 's|.github/rustframe_logo.png|rustframe_logo.png|g' README.md - name: Build documentation run: cargo doc --no-deps --release @@ -111,7 +111,8 @@ jobs: cp tarpaulin-report.json target/doc/docs/ cp tarpaulin-badge.json target/doc/docs/ cp last-commit-date.json target/doc/docs/ - cp -r .github target/doc/docs + # cp -r .github target/doc/docs + cp .github/rustframe_logo.png target/doc/docs/ echo "" > target/doc/index.html touch target/doc/.nojekyll From 1c41d387ef5f960af34a2a125e4c17b7d407f549 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:32:57 +0100 Subject: [PATCH 13/14] Update verification step to check for logo presence in output directory --- .github/workflows/docs-and-testcov.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index ff6c445..9820b86 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -116,11 +116,11 @@ jobs: echo "" > target/doc/index.html touch target/doc/.nojekyll - # verify that .github exists in the output directory - - name: Verify .github directory + # verify that logo exists in the output directory + - name: Verify logo directory run: | - if [ ! -d target/doc/docs/.github ]; then - echo ".github directory not found in output!" + if [ ! -f target/doc/docs/rustframe_logo.png ]; then + echo "Logo not found in output directory!" exit 1 fi From 37d10cbc7de00349c55b84d3cdca5debbaa04d52 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 5 May 2025 03:42:52 +0100 Subject: [PATCH 14/14] Remove 'fix_docs' branch from push trigger in workflow configuration --- .github/workflows/docs-and-testcov.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 9820b86..8ace0a8 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -6,7 +6,7 @@ concurrency: on: push: - branches: [main, fix_docs] + branches: [main] # pull_request: # branches: [main] workflow_dispatch: