new changes

Signed-off-by: SGudla <[email protected]>

Author: SaikiranGudla

.github/workflows/documentation.yaml .github/workflows/build-doc.yaml

@@ -28,6 +28,12 @@ jobs:
           popd
 
           echo "Sphinx was generated successfully!"
+
+      - name: Store the generated doc
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-sphinix
+          path: doc/sphinix/build
 
       - name: Doxygen build
         run: |
@@ -39,4 +45,10 @@ jobs:
           cd ..
           popd
 
-          echo "Doxygen was generated successfully!"
+          echo "Doxygen was generated successfully!"
+
+      - name: Store the generated doc
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-doxygen
+          path: doc/doxygen/build/html

.github/workflows/deploy-doc.yaml

@@ -1,55 +1,46 @@
 name: Deploy Doc 
 
 on: workflow_call
-jobs: 
-  deploy-docs:
+jobs:
+  deploy-doc:
     runs-on: ubuntu-latest
-    # needs: docs
-    # if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/sphinx-web-documentation')
+    permissions:
+      contents: write
+
     steps:
-      - name: Update gh pages
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "CSE-CI"
-
-          MASTER_COMMIT=$(git rev-parse --short HEAD)
-          REPO_SLUG="${REPO_SLUG:-analogdevicesinc/precision-converters-firmware}"
-
-          # Fetch and checkout to gh-pages branch
-          git fetch --depth 1 origin +refs/heads/gh-pages:gh-pages
-          git checkout gh-pages
-
-          # Clear previous content in the root folder of 'gh-pages' branch except 
-          # the 'doc' folder which holds new builds
-          find -mindepth 1 -maxdepth 1 ! \( -name "doc" -o -name ".git" \) -exec rm -rf {} \;
-          
-          # Add sphinx build html content to root folder in the 'gh-pages' branch
-          cp -r doc/sphinx/build/* ./
-
-          # Create doxygen folder holding new build content and add doxygen html content
-          # to doxygen/ folder in the 'gh-pages' branch
-          mkdir -p doxygen
-          cp -r doc/doxygen/build/html/* doxygen/
-
-          # Remove temporary 'doc' folder
-          rm -rf doc/
-
-          # Create .nojekyll file to handle files starting with '_' on gh pages
-          touch .nojekyll
-
-          # Push contents to 'gh-pages' branch
-          CURRENT_COMMIT=$(git log -1 --pretty=%B)
-          if [[ ${CURRENT_COMMIT:(-7)} != ${MASTER_COMMIT:0:7} ]]
-          then
-                  git add --all .
-                  git commit --allow-empty --amend -m "Update documentation to ${MASTER_COMMIT:0:7}"
-                  if [ -n "$GITHUB_DOC_TOKEN" ] ; then
-                          git push https://${GITHUB_DOC_TOKEN}@github.com/${REPO_SLUG} gh-pages -f
-                  else
-                          git push origin gh-pages -f
-                  fi
-
-                  echo "Documetation updated!"
-          else
-                  echo "Documentation already up to date!"
-          fi
+    - uses: actions/checkout@v4
+      ref: 'gh-pages'
+
+    - name: Empty gh-pages
+      run: |
+        git rm -r . --quiet
+
+    - uses: actions/download-artifact@v4
+      with:
+        name: html-sphinx
+        
+    - uses: actions/download-artifact@v4
+      with:
+        name: html-doxygen
+        path: doxygen
+
+    - name: Patch doc build
+      run: |
+        rm -r _sources
+        touch .nojekyll
+
+    - name: Commit gh-pages
+      run: |
+        author=$(git log -1 --pretty=format:'%an')
+        email=$(git log -1 --pretty=format:'%ae')
+        commit=$(git rev-parse --short HEAD)
+
+        git add . >> /dev/null
+        git config --global user.name "$author"
+        git config --global user.email "$email"
+        git commit -m "deploy: $commit" --allow-empty
+
+
+    - name: Push to gh-pages
+      run: >-
+        git push origin gh-pages:gh-pages

.github/workflows/main.yaml

@@ -16,10 +16,10 @@ jobs:
     needs: [check-versions]
     secrets: inherit 
   documentation:
-    uses: ./.github/workflows/documentation.yaml
+    uses: ./.github/workflows/build-doc.yaml
     needs: [lint]
     secrets: inherit
   deploy-doc:
     uses: ./.github/workflows/deploy-doc.yaml
-    needs: [documentation]
+    needs: [build-doc]
     secrets: inherit

.github/workflows/pr.yaml

@@ -14,6 +14,6 @@ jobs:
     needs: [check-versions]
     secrets: inherit 
   documentation:
-    uses: ./.github/workflows/documentation.yaml
+    uses: ./.github/workflows/build-doc.yaml
     needs: [lint]
     secrets: inherit