From 2c087d1ac6a97954f5fd0c70934361703d379aa0 Mon Sep 17 00:00:00 2001 From: Jan Speller Date: Mon, 23 May 2022 23:36:00 +0200 Subject: [PATCH 1/4] Add feature/gh-pages branch to documentation-build pipeline for testing, change deployment to gh-pages --- .github/workflows/build_docs.yml | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index dfb0de3..e60b666 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -4,6 +4,7 @@ on: push: branches: - master + - feature/gh-pages jobs: @@ -26,14 +27,4 @@ jobs: python -m pip install --upgrade pip pip install mkdocs python -m mkdocs build -f docu/mkdocs.yml - - - name: Upload to docs-server - uses: appleboy/scp-action@master - with: - host: ${{ secrets.SCP_HOST }} - port: ${{ secrets.SCP_PORT }} - username: ${{ secrets.SCP_USERNAME }} - password: ${{ secrets.SCP_PASSWORD }} - source: "docu/site/**" - target: ${{ secrets.SCP_TARGET_PATH }} - strip_components: 2 + - run: python -m mkdocs gh-deploy --force From ed7c754e7103d76914fe136e42c74cb731b0683b Mon Sep 17 00:00:00 2001 From: Jan Speller Date: Mon, 23 May 2022 23:38:40 +0200 Subject: [PATCH 2/4] add file to mkdocs gh-deploy --- .github/workflows/build_docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index e60b666..ec85c7e 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -27,4 +27,4 @@ jobs: python -m pip install --upgrade pip pip install mkdocs python -m mkdocs build -f docu/mkdocs.yml - - run: python -m mkdocs gh-deploy --force + - run: python -m mkdocs gh-deploy -f docu/mkdocs.yml --force From 22d122f096a3113290018586f4ae528e3a6cbb8c Mon Sep 17 00:00:00 2001 From: Jan Speller Date: Mon, 23 May 2022 23:49:21 +0200 Subject: [PATCH 3/4] upgrade to checkout v2, install python via action, add missing files to docs --- .github/workflows/build_docs.yml | 21 ++++++++++++++------- docu/mkdocs.yml | 2 ++ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index ec85c7e..70ff98c 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -11,10 +11,19 @@ jobs: build_docs: name: Build documentation runs-on: ubuntu-latest + strategy: + matrix: + python-version: ['3.10'] steps: - name: Checkout - uses: actions/checkout@v1 + uses: actions/checkout@v2 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + architecture: x64 - name: Build doxygen uses: mattnotmitt/doxygen-action@v1 @@ -22,9 +31,7 @@ jobs: working-directory: './' doxyfile-path: 'docu/doxygen.ini' - - name: Build mkdocs - run: | - python -m pip install --upgrade pip - pip install mkdocs - python -m mkdocs build -f docu/mkdocs.yml - - run: python -m mkdocs gh-deploy -f docu/mkdocs.yml --force + - name: Install mkdocs + run: pip install mkdocs + - name: Build Docs and Deploy to Github Pages + run: python -m mkdocs gh-deploy -f docu/mkdocs.yml --force diff --git a/docu/mkdocs.yml b/docu/mkdocs.yml index ff4f904..3fdd515 100644 --- a/docu/mkdocs.yml +++ b/docu/mkdocs.yml @@ -26,6 +26,8 @@ nav: - Plugins: - Http: plugin/http.md - Telegram: plugin/telegram.md + - Divera: plugin/divera.md + - MySQL: plugin/mysql.md - Entwickler: - Eigenes Modul/Plugin schreiben: develop/ModulPlugin.md - BOSWatch Alarmpaket Format: develop/packet.md From 41d7f7b650ee4c102e2c8f0fdba420388a864733 Mon Sep 17 00:00:00 2001 From: Bastian Schroll Date: Tue, 24 May 2022 10:27:23 +0200 Subject: [PATCH 4/4] add dev branch use dev branch as docs source until release --- .github/workflows/build_docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 70ff98c..e2d1823 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -3,8 +3,8 @@ name: build_docs on: push: branches: - - master - - feature/gh-pages +# - master + - develop jobs: