add docs release workflow

asv-soft · Dec 25, 2024 · b41d495 · b41d495
1 parent d865341
commit b41d495
Show file tree

Hide file tree

Showing 3 changed files with 192 additions and 4 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,186 @@
+name: Release docs
+
+on:
+  push:
+    tags:
+      - 'docs-v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: write
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: 'Writerside/am'
+  DOCKER_VERSION: '243.21565'
+  PDF: 'PDF.xml'
+  CONFIG_JSON_PRODUCT: 'IN'
+#  ALGOLIA_INDEX_NAME: 'asv.mavlink'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      instance_id_upper: ${{ steps.define-ids.outputs.instance_id_upper }}
+      algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
+      artifact: ${{ steps.define-ids.outputs.artifact }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Define instance ID
+        id: define-ids
+        run: |
+          INSTANCE_ID="${INSTANCE#*/}"
+          INSTANCE_ID_UPPER=$(echo "$INSTANCE_ID" | tr '[:lower:]' '[:upper:]')
+          ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
+          ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
+          
+          echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
+          echo "ARTIFACT: $ARTIFACT"
+          echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
+          
+          echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
+          echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
+          echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
+          
+          echo "instance_id_upper=$INSTANCE_ID_UPPER" >> $GITHUB_OUTPUT
+          echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
+          echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
+          
+      - name: Build Writerside docs using Docker in ZIP
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+          artifact: ${{ env.ARTIFACT }}
+
+      - name: Build Writerside docs using Docker in PDF
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+          pdf: ${{ env.PDF }}
+
+      - name: Save artifact with build results
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            artifacts/pdfSource${{ env.INSTANCE_ID_UPPER }}.pdf
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+            artifacts/${{ env.ALGOLIA_ARTIFACT }}
+          retention-days: 1
+
+  test:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  create-release:
+    needs: [build, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Show outputs
+        run: |
+          echo "INSTANCE_ID_UPPER: ${{ needs.build.outputs.instance_id_upper }}"
+          echo "ARTIFACT: ${{ needs.build.outputs.artifact }}"
+          echo "ALGOLIA_ARTIFACT: ${{ needs.build.outputs.algolia_artifact }}"
+      
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref }}
+          name: "Release ${{ github.ref_name }}"
+          draft: false
+          prerelease: ${{ contains(github.ref, 'alpha') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GIHUB_NUGET_AUTH_TOKEN }}
+
+      - name: Upload artifact to release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            artifacts/pdfSource${{ needs.build.outputs.instance_id_upper }}.pdf
+            artifacts/${{ needs.build.outputs.artifact }}
+            artifacts/report.json
+            artifacts/${{ needs.build.outputs.algolia_artifact }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GIHUB_NUGET_AUTH_TOKEN }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: [ build, test, create-release ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Package and upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+#  publish-indexes:
+#    needs: [build, test, create-release, deploy]
+#    runs-on: ubuntu-latest
+#    container:
+#      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
+#    steps:
+#      - name: Download artifact
+#        uses: actions/download-artifact@v4
+#        with:
+#          name: docs
+#          path: artifacts
+#      - name: Unzip Algolia artifact
+#        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.algolia_artifact }}" -d algolia-indexes
+#      - name: Update Algolia Index
+#        run: |
+#          if [ -z "${{ secrets.ALGOLIA_KEY }}" ]; then
+#            echo "ALGOLIA_KEY secret is not set in GitHub Secrets"
+#            exit 1
+#          else
+#            env "algolia-key=${{ secrets.ALGOLIA_KEY }}" java -jar /opt/builder/help-publication-agent.jar \
+#            update-index \
+#            --application-name ${{ secrets.ALGOLIA_ID }} \
+#            --index-name ${{ env.ALGOLIA_INDEX_NAME }} \
+#            --product ${{ env.CONFIG_JSON_PRODUCT }} \
+#            --index-directory algolia-indexes/ \
+#            2>&1 | tee algolia-update-index-log.txt
+#          fi
diff --git a/docs/Writerside/topics/GetStarted/With-Ardu-SITL.md b/docs/Writerside/topics/GetStarted/With-Ardu-SITL.md
@@ -26,14 +26,15 @@ docker run -p 5760:5760 flurps1/asv-sitl
 *If you have any problems with this SITL it is better to use [docker](#with-docker)*
 
 1. Download files from [here](https://firmware.ardupilot.org/Tools/MissionPlanner/sitl/CopterStable/) and put them in any folder.
-2. Create a ```.bat``` file in the folder with name ```run_copter.bat```.
-3. Edit this file with a notepad and add code:
+2. Change all ```.elf``` to ```.exe```
+3. Create a ```.bat``` file in the folder with name ```run_copter.bat```.
+4. Edit this file with a notepad and add code:
 ```text
 ArduCopter.exe -M+ -O55.2905802,61.6063891,191.303759999999,0 -s10 --uartA tcp:0 
 rm logs
 ```
-3. Run .bat file.
-4. Now SITL is online.
+5. Run .bat file.
+6. Now SITL is online.
 ![image](bat-sitl-windows.jpg)
 
 ## How to connect to SITL with Asv.Mavlink library

diff --git a/src/Asv.Mavlink.sln b/src/Asv.Mavlink.sln
@@ -19,6 +19,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution items", "Solution
 		Directory.Build.props = Directory.Build.props
 		..\.github\workflows\release_debug_version.yml = ..\.github\workflows\release_debug_version.yml
 		..\.github\workflows\release-action.yml = ..\.github\workflows\release-action.yml
+		..\.github\workflows\docs.yml = ..\.github\workflows\docs.yml
 	EndProjectSection
 EndProject
 Global