From bd835ce6d8e7ed3918b8656a9c3551c993dcb363 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:04:03 +0700 Subject: [PATCH 01/21] Update Doxyfile --- Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index 82da17d..1a27e44 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = ./doc/ # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and From 5b564af409f927d8eac9196f0958374d9c6aff80 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:08:13 +0700 Subject: [PATCH 02/21] Update Doxyfile --- Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index 1a27e44..bfcbec6 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ./doc/ +OUTPUT_DIRECTORY = ./docs/ # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and From 84367f66105a1392d365a8b605f07c36a2b3c48d Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:08:19 +0700 Subject: [PATCH 03/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 283ffbc..7d3ab53 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -11,28 +11,44 @@ jobs: runs-on: ubuntu-latest steps: - # Step 1: Check-out current repository - name: Checkout current repository uses: actions/checkout@v4 - # Step 2: Clone SinricPro repository + - name: Create new branch + run: | + git config --local user.email "action@github.com" + git config --local user.name "doxygen-bot" + git checkout -b update-doxygen-documentation + - name: Clone external repository run: | git clone https://github.com/sinricpro/esp8266-esp32-sdk - # Step 3: Install Doxygen - name: Install Doxygen run: | sudo apt-get install -y doxygen graphviz - # Step 4: Generate Documentation - name: Generate Documentation run: | doxygen Doxyfile - # Step 5: Deploy to GitHub Pages - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v4 + - name: Commit changes + run: | + git add . + git commit -m "Update Doxygen documentation" || echo "No changes to commit" + + - name: Push changes + uses: ad-m/github-push-action@master with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs + branch: update-doxygen-documentation + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: Update Doxygen documentation + title: 'Update Doxygen documentation' + body: 'This PR updates the Doxygen documentation.' + branch: update-doxygen-documentation + base: main From a75515f28b0827ece7b37718193012b208373ff0 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:11:33 +0700 Subject: [PATCH 04/21] Update Doxyfile --- Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index bfcbec6..82da17d 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ./docs/ +OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and From 6d1d6f82721c947b8a258b8db7d0030a9eb9f883 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:17:37 +0700 Subject: [PATCH 05/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 7d3ab53..80c7077 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -36,7 +36,8 @@ jobs: run: | git add . git commit -m "Update Doxygen documentation" || echo "No changes to commit" - + git pull --rebase origin master + - name: Push changes uses: ad-m/github-push-action@master with: From 960deb37108ae0597cb74f81c1ba960ffb09d905 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:22:21 +0700 Subject: [PATCH 06/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 80c7077..2c9302f 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -19,6 +19,7 @@ jobs: git config --local user.email "action@github.com" git config --local user.name "doxygen-bot" git checkout -b update-doxygen-documentation + git pull - name: Clone external repository run: | @@ -36,7 +37,6 @@ jobs: run: | git add . git commit -m "Update Doxygen documentation" || echo "No changes to commit" - git pull --rebase origin master - name: Push changes uses: ad-m/github-push-action@master From 820f6f8c00df8a4efbff8b167354b2ed1eebe5be Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:26:53 +0700 Subject: [PATCH 07/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 2c9302f..2c5bbb3 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -18,8 +18,7 @@ jobs: run: | git config --local user.email "action@github.com" git config --local user.name "doxygen-bot" - git checkout -b update-doxygen-documentation - git pull + git checkout -b update-doxygen-documentation - name: Clone external repository run: | @@ -35,8 +34,9 @@ jobs: - name: Commit changes run: | - git add . + git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" + git fetch - name: Push changes uses: ad-m/github-push-action@master From 0463a18d2e1abd2cd27f51b9c3d32c211f1f5db4 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:35:50 +0700 Subject: [PATCH 08/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 2c5bbb3..4d704ab 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -13,6 +13,8 @@ jobs: steps: - name: Checkout current repository uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Create new branch run: | @@ -34,6 +36,7 @@ jobs: - name: Commit changes run: | + git rm --cached esp8266-esp32-sdk git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" git fetch From 16c4c62b668bbf570ad168a53ccea480300e9d39 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:38:01 +0700 Subject: [PATCH 09/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 4d704ab..f8bc94a 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -36,7 +36,6 @@ jobs: - name: Commit changes run: | - git rm --cached esp8266-esp32-sdk git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" git fetch From 9e51283b1e616b5706d6f204a90f744ad580c3ff Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:40:47 +0700 Subject: [PATCH 10/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index f8bc94a..f12129d 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -38,7 +38,7 @@ jobs: run: | git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" - git fetch + git pull - name: Push changes uses: ad-m/github-push-action@master From 90676863b114247c45ec2f20e71d3e6317f03550 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:44:22 +0700 Subject: [PATCH 11/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index f12129d..a80cd84 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -38,7 +38,7 @@ jobs: run: | git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" - git pull + git branch --set-upstream-to=origin/update-doxygen-documentation - name: Push changes uses: ad-m/github-push-action@master From 6b46abc1eade2f8066ee19be386445a47102983e Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:48:28 +0700 Subject: [PATCH 12/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index a80cd84..14d061f 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -18,6 +18,7 @@ jobs: - name: Create new branch run: | + git config --global push.autoSetupRemote true git config --local user.email "action@github.com" git config --local user.name "doxygen-bot" git checkout -b update-doxygen-documentation From 2b92c866cfd7df3af3deac2ef0e6c8ec66addb75 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:50:05 +0700 Subject: [PATCH 13/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 14d061f..ae4b761 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -39,13 +39,7 @@ jobs: run: | git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" - git branch --set-upstream-to=origin/update-doxygen-documentation - - - name: Push changes - uses: ad-m/github-push-action@master - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - branch: update-doxygen-documentation + git push -u origin update-doxygen-documentation - name: Create Pull Request uses: peter-evans/create-pull-request@v3 From ee50262ab3632f993b82c03dfebba76175ff4c4f Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:52:28 +0700 Subject: [PATCH 14/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index ae4b761..7f5f4cc 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -49,4 +49,4 @@ jobs: title: 'Update Doxygen documentation' body: 'This PR updates the Doxygen documentation.' branch: update-doxygen-documentation - base: main + base: master From 753d87ef29ce27a50f7a738646a51e935f4ae59e Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:55:00 +0700 Subject: [PATCH 15/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 7f5f4cc..1b0b89b 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -37,7 +37,8 @@ jobs: - name: Commit changes run: | - git add docs/* + git rm --cached esp8266-esp32-sdk + git add . git commit -m "Update Doxygen documentation" || echo "No changes to commit" git push -u origin update-doxygen-documentation From 16e00bd7f737aa9ef55d63511e74eb330f9eb327 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:58:07 +0700 Subject: [PATCH 16/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 1b0b89b..261f12d 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -37,9 +37,10 @@ jobs: - name: Commit changes run: | - git rm --cached esp8266-esp32-sdk - git add . + ls -lR + git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" + git rm --cached esp8266-esp32-sdk git push -u origin update-doxygen-documentation - name: Create Pull Request From d24f373ec9be64cf482dc5c97d235724803c37bd Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 18:59:48 +0700 Subject: [PATCH 17/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 261f12d..66d4ad5 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -37,6 +37,7 @@ jobs: - name: Commit changes run: | + rm -rf ./esp8266-esp32-sdk ls -lR git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" From 1124061c34e0a69085f327f868172a6c64351e87 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 20:42:53 +0700 Subject: [PATCH 18/21] Update Doxyfile --- Doxyfile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Doxyfile b/Doxyfile index 82da17d..2a888cc 100644 --- a/Doxyfile +++ b/Doxyfile @@ -864,9 +864,9 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ..\esp8266-esp32-sdk\src \ - ..\esp8266-esp32-sdk\README.md \ - ..\esp8266-esp32-sdk\src\Capabilities \ +INPUT = ./esp8266-esp32-sdk/src \ + ./esp8266-esp32-sdk/README.md \ + ./esp8266-esp32-sdk/src/Capabilities \ documentation.dox # This tag can be used to specify the character encoding of the source files From 8c0ecfc92dab619346e396146f0a34fa143a2090 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 20:44:31 +0700 Subject: [PATCH 19/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 66d4ad5..bf93713 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -41,7 +41,6 @@ jobs: ls -lR git add docs/* git commit -m "Update Doxygen documentation" || echo "No changes to commit" - git rm --cached esp8266-esp32-sdk git push -u origin update-doxygen-documentation - name: Create Pull Request From d38582c3b0c199c4b249b624d9dbd4bafe05e3d1 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 20:50:12 +0700 Subject: [PATCH 20/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index bf93713..627ab0c 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -37,9 +37,9 @@ jobs: - name: Commit changes run: | - rm -rf ./esp8266-esp32-sdk - ls -lR - git add docs/* + ls -l + git add . + git status git commit -m "Update Doxygen documentation" || echo "No changes to commit" git push -u origin update-doxygen-documentation From 11628dade14c375ba96bedee16e80726d1e6cd29 Mon Sep 17 00:00:00 2001 From: Aruna Tennakoon Date: Fri, 4 Oct 2024 20:56:47 +0700 Subject: [PATCH 21/21] Update doxygen.yml --- .github/workflows/doxygen.yml | 38 ++++++++++------------------------- 1 file changed, 11 insertions(+), 27 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 627ab0c..c7a34b2 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -3,52 +3,36 @@ name: Generate Doxygen Documentation on: push: branches: - - main - workflow_dispatch: + - main # Ausführung bei Pushes auf den 'main' Branch + workflow_dispatch: # Manuelles Auslösen der Action jobs: generate-docs: runs-on: ubuntu-latest steps: + # Step 1: Check-out current repository - name: Checkout current repository uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Create new branch - run: | - git config --global push.autoSetupRemote true - git config --local user.email "action@github.com" - git config --local user.name "doxygen-bot" - git checkout -b update-doxygen-documentation + # Step 2: Clone SinricPro repository - name: Clone external repository run: | git clone https://github.com/sinricpro/esp8266-esp32-sdk + # Step 3: Install Doxygen - name: Install Doxygen run: | sudo apt-get install -y doxygen graphviz + # Step 4: Generate Documentation - name: Generate Documentation run: | doxygen Doxyfile - - name: Commit changes - run: | - ls -l - git add . - git status - git commit -m "Update Doxygen documentation" || echo "No changes to commit" - git push -u origin update-doxygen-documentation - - - name: Create Pull Request - uses: peter-evans/create-pull-request@v3 + # Step 5: Deploy to GitHub Pages + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update Doxygen documentation - title: 'Update Doxygen documentation' - body: 'This PR updates the Doxygen documentation.' - branch: update-doxygen-documentation - base: master + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs # Pfad zur generierten Dokumentation