documentation preview in PRs

documentation preview in PRs

Pull Request resolved: https://github.com/ydb-platform/ydb/pull/439

.github/workflows/docs_build.yaml

@@ -12,14 +12,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Build
-        uses: diplodoc-platform/docs-build-action@v1
+        uses: diplodoc-platform/docs-build-action@v3
         with:
           revision: "pr-${{ github.event.pull_request.number }}"
-          project-name: ${{ secrets.DOCS_PROJECT_NAME }}
           src-root: ${{ vars.SRC_ROOT }}
-          storage-bucket: ${{ secrets.DOCS_AWS_BUCKET }}
-          storage-endpoint: ${{ vars.DOCS_AWS_ENDPOINT }}
-          storage-access-key-id: ${{ secrets.DOCS_AWS_KEY_ID }}
-          storage-secret-access-key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }}
-          storage-region: ${{ vars.DOCS_AWS_REGION }}
-          shared-storage-bucket: true

.github/workflows/docs_preview.yaml

@@ -0,0 +1,30 @@
+name: Preview documentation
+
+on:
+  workflow_run:
+    workflows:
+      - Build documentation
+    types:
+      - completed
+
+jobs:
+  post-build:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - name: Upload
+        uses: diplodoc-platform/docs-upload-action@v1
+        if: github.event.workflow_run.conclusion == 'success'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          storage-endpoint: ${{ vars.DOCS_AWS_ENDPOINT }}
+          storage-region: ${{ vars.DOCS_AWS_REGION }}
+          storage-bucket: ${{ vars.DIPLODOC_STORAGE_BUCKET }}
+          storage-access-key-id: ${{ secrets.DOCS_AWS_KEY_ID }}
+          storage-secret-access-key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }}
+
+      - name: Comment message
+        uses: diplodoc-platform/docs-message-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          project-link: ${{ vars.DIPLODOC_PROJECT_LINK }}

.mapping.json

@@ -39,6 +39,7 @@
   ".github/workflows/build_and_test_ya_provisioned.yml":"ydb/github_toplevel/.github/workflows/build_and_test_ya_provisioned.yml",
   ".github/workflows/docker_publish.yml":"ydb/github_toplevel/.github/workflows/docker_publish.yml",
   ".github/workflows/docs_build.yaml":"ydb/github_toplevel/.github/workflows/docs_build.yaml",
+  ".github/workflows/docs_preview.yaml":"ydb/github_toplevel/.github/workflows/docs_preview.yaml",
   ".github/workflows/docs_release.yaml":"ydb/github_toplevel/.github/workflows/docs_release.yaml",
   ".github/workflows/nightly_run.yaml":"ydb/github_toplevel/.github/workflows/nightly_run.yaml",
   ".github/workflows/pr_check.yml":"ydb/github_toplevel/.github/workflows/pr_check.yml",

ydb/docs/build.sh

@@ -1,6 +1,5 @@
 # Use this script to build YDB docs with Open Source tools and start HTTP server
 # You may specify output directory as a parameter. If omitted, docs will be generated to a TEMP subdirectory
-#
 
 echo Checking YFM installed...
 yfm --version