From af8b1f0472300787753b7d15250ae1c454bbe136 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Wed, 16 Jul 2025 16:07:36 +0300 Subject: [PATCH 1/7] Add docs to github workflow Signed-off-by: Sebastian --- .github/workflows/docs.yml | 57 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..e559b80c --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,57 @@ +name: ๐Ÿ“š Generate Documentation + +on: + push: + branches: [ main ] + paths: + - 'mcpgateway/**' + - 'docs/**' + - 'README.md' + - 'mkdocs.yml' + workflow_dispatch: + +jobs: + docs: + runs-on: ubuntu-latest + permissions: + contents: write + pages: write + id-token: write + + steps: + - name: ๐Ÿ“ฆ Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y graphviz + + - name: ๐Ÿ“š Install Python dependencies + run: | + python -m pip install --upgrade pip + pip install code2flow snakefood3 pylint handsdown mkdocs mkdocs-material + + - name: ๐Ÿงช Run tests for reports + run: make test || true # Continue even if tests fail + + - name: ๐Ÿ“ Generate documentation + run: make docs + + - name: ๐Ÿ’พ Commit documentation changes + run: | + git add docs/ || true + git commit -m "๐Ÿ“š Update documentation [skip ci]" -a || true + git push || true + + - name: ๐Ÿš€ Setup Pages + uses: actions/configure-pages@v3 + + - name: ๐Ÿ“‹ Build with MkDocs + run: mkdocs build + + - name: ๐Ÿ“ค Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: './site' + + - name: ๐ŸŒ Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 From 6c2e709f7b0bbbb734d96c4906b5c6ece6af16c2 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Wed, 16 Jul 2025 17:08:15 +0300 Subject: [PATCH 2/7] Testing commit Signed-off-by: Sebastian --- .github/workflows/docs.yml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e559b80c..02debe33 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,6 +1,8 @@ name: ๐Ÿ“š Generate Documentation on: + pull_request: + branches: ["main"] push: branches: [ main ] paths: @@ -30,16 +32,16 @@ jobs: pip install code2flow snakefood3 pylint handsdown mkdocs mkdocs-material - name: ๐Ÿงช Run tests for reports - run: make test || true # Continue even if tests fail + run: make test - name: ๐Ÿ“ Generate documentation run: make docs - - name: ๐Ÿ’พ Commit documentation changes - run: | - git add docs/ || true - git commit -m "๐Ÿ“š Update documentation [skip ci]" -a || true - git push || true + # - name: ๐Ÿ’พ Commit documentation changes + # run: | + # git add docs/ || true + # git commit -m "๐Ÿ“š Update documentation [skip ci]" -a || true + # git push || true - name: ๐Ÿš€ Setup Pages uses: actions/configure-pages@v3 @@ -52,6 +54,6 @@ jobs: with: path: './site' - - name: ๐ŸŒ Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v2 + # - name: ๐ŸŒ Deploy to GitHub Pages + # id: deployment + # uses: actions/deploy-pages@v2 From 2a68a1a50fee4456845eeb831e469eb437688265 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Wed, 16 Jul 2025 17:35:24 +0300 Subject: [PATCH 3/7] Update github actions v4 Signed-off-by: Sebastian --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 02debe33..f18d6a56 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -44,7 +44,7 @@ jobs: # git push || true - name: ๐Ÿš€ Setup Pages - uses: actions/configure-pages@v3 + uses: actions/configure-pages@v4 - name: ๐Ÿ“‹ Build with MkDocs run: mkdocs build From 088a8918e2bd71137eb14b24b6834407c11caa9f Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 17 Jul 2025 09:52:27 +0300 Subject: [PATCH 4/7] Artifact v4 Signed-off-by: Sebastian --- .github/workflows/docs.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f18d6a56..d6336d1f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -37,12 +37,6 @@ jobs: - name: ๐Ÿ“ Generate documentation run: make docs - # - name: ๐Ÿ’พ Commit documentation changes - # run: | - # git add docs/ || true - # git commit -m "๐Ÿ“š Update documentation [skip ci]" -a || true - # git push || true - - name: ๐Ÿš€ Setup Pages uses: actions/configure-pages@v4 @@ -50,7 +44,7 @@ jobs: run: mkdocs build - name: ๐Ÿ“ค Upload artifact - uses: actions/upload-pages-artifact@v2 + uses: actions/upload-pages-artifact@v4 with: path: './site' From ebee74099f3060bb4b2223c96de0f3b86220d291 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 17 Jul 2025 10:05:58 +0300 Subject: [PATCH 5/7] downgrade upload-pages v3 Signed-off-by: Sebastian --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d6336d1f..c5b70118 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -44,7 +44,7 @@ jobs: run: mkdocs build - name: ๐Ÿ“ค Upload artifact - uses: actions/upload-pages-artifact@v4 + uses: actions/upload-pages-artifact@v3 with: path: './site' From ca50573abe3bf785774d63aebfb64c82986d4436 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 17 Jul 2025 10:10:01 +0300 Subject: [PATCH 6/7] Dependencies update Signed-off-by: Sebastian --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c5b70118..89fc201e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,7 +29,7 @@ jobs: - name: ๐Ÿ“š Install Python dependencies run: | python -m pip install --upgrade pip - pip install code2flow snakefood3 pylint handsdown mkdocs mkdocs-material + pip install code2flow snakefood3 pylint handsdown mkdocs mkdocs-material pytest - name: ๐Ÿงช Run tests for reports run: make test From a652550c6f766842a8bd523dbe42a0d73cde6d3d Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 17 Jul 2025 10:37:25 +0300 Subject: [PATCH 7/7] Explicit path to Makefile Signed-off-by: Sebastian --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 89fc201e..8214118c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,7 +32,7 @@ jobs: pip install code2flow snakefood3 pylint handsdown mkdocs mkdocs-material pytest - name: ๐Ÿงช Run tests for reports - run: make test + run: make -f ./Makefile test - name: ๐Ÿ“ Generate documentation run: make docs