Configuration: improve doc publication (#2422)

arrow-kt · Jun 22, 2021 · d1c934a · d1c934a
1 parent 31327c1
commit d1c934a
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 22 deletions.
diff --git a/.github/scripts/publish-landing-page.sh b/.github/scripts/publish-landing-page.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Reason: The root directory also has docs/, docs/next/ and docs/<major.minor>. 
+
 set -e
 
 MAIN_CONTENT=("CNAME"  "code"  "css"  "error.html"  "fonts"  "img"  "index.html"  "js"  "redirects.json")

diff --git a/.github/scripts/publish-latest-release.sh b/.github/scripts/publish-latest-release.sh
@@ -5,17 +5,13 @@
 
 set -e
 
-MAIN_CONTENT=("CNAME"  "code"  "css"  "error.html"  "fonts"  "img"  "index.html"  "js"  "redirects.json")
-
 cd _site/
 for file in *; do
-    if [[ ! ${MAIN_CONTENT[*]} =~ "$file" ]]; then
-        if [ -f "$file" ]; then
-            echo "Copying $file ..."
-            aws s3 cp $file s3://$S3_BUCKET/docs/$file >> $BASEDIR/logs/aws_sync.log
-            continue
-        fi
-        echo "Sync $file ..."
-        aws s3 sync $file s3://$S3_BUCKET/docs/$file --delete >> $BASEDIR/logs/aws_sync.log
+    if [ -f "$file" ]; then
+        echo "Copying $file ..."
+        aws s3 cp $file s3://$S3_BUCKET/docs/$file >> $BASEDIR/logs/aws_sync.log
+        continue
     fi
+    echo "Sync $file ..."
+    aws s3 sync $file s3://$S3_BUCKET/docs/$file --delete >> $BASEDIR/logs/aws_sync.log
 done
diff --git a/.github/workflows/build_doc.yml b/.github/workflows/build_doc.yml
@@ -22,6 +22,9 @@ jobs:
       run: ${GITHUB_WORKSPACE}/.github/scripts/set-env.sh
     - name: "Show env"
       run: ${GITHUB_WORKSPACE}/.github/scripts/show-env.sh
-    - name: "Create API doc and validate documentation"
+    - name: "Create API doc"
       working-directory: arrow-libs
-      run: ./gradlew buildDoc
+      run: ./gradlew dokka
+    - name: "Validate documentation"
+      working-directory: arrow-site
+      run: ./gradlew runAnk
diff --git a/.github/workflows/publish_doc.yml b/.github/workflows/publish_doc.yml
@@ -47,35 +47,46 @@ jobs:
         brew install tree
         bundle install --gemfile Gemfile --path vendor/bundle
 
-    - name: "Create API doc and validate documentation"
+    - name: "Create API doc"
       working-directory: arrow-libs
-      run: ./gradlew buildDoc
+      run: ./gradlew dokka
+
+    - name: "Validate documentation"
+      working-directory: arrow-site
+      run: ./gradlew runAnk
 
     - name: "Landing page: build"
-      if: ${{ github.ref == 'refs/heads/main' }}
+      if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
       working-directory: arrow-site
       run: |
-        bundle exec jekyll build -b docs -s build/site
-        tree _site > $BASEDIR/logs/content_docs.log
+        bundle exec jekyll build -s build/site
+        tree _site > $BASEDIR/logs/content.log
 
     - name: "Landing page: publish"
-      if: ${{ github.ref == 'refs/heads/main' }}
+      if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
       working-directory: arrow-site
       run: |
         echo ">>> Landing page" >> $BASEDIR/logs/aws_sync.log
         ${GITHUB_WORKSPACE}/.github/scripts/publish-landing-page.sh
 
+    - name: "Remove index for versions"
+      working-directory: arrow-site
+      run: rm -f build/site/index.md
+
+    - name: "Latest release: build (docs/)"
+      if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
+      working-directory: arrow-site
+      run: |
+        bundle exec jekyll build -b docs -s build/site
+        tree _site > $BASEDIR/logs/content_docs.log
+
     - name: "Latest release: publish (docs/)"
       if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
       working-directory: arrow-site
       run: |
         echo ">>> Latest release" >> $BASEDIR/logs/aws_sync.log
         ${GITHUB_WORKSPACE}/.github/scripts/publish-latest-release.sh
 
-    - name: "Remove index for versions"
-      working-directory: arrow-site
-      run: rm -f build/site/index.md
-
     - name: "Latest release: build release directory (docs/<major.minor>)"
       if: env.NEW_RELEASE_VERSION_EXISTS == '1'
       working-directory: arrow-site

diff --git a/arrow-site/build.gradle b/arrow-site/build.gradle
@@ -29,6 +29,7 @@ dependencies {
     kapt "io.arrow-kt:arrow-meta:$VERSION_NAME"
 }
 
+// Ank Plugin is not applied for every library to avoid adding runtime dependencies
 apply plugin: 'ank-gradle-plugin'
 
 ank {
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,6 +29,7 @@ dependencies { @@
         kapt "io.arrow-kt:arrow-meta:$VERSION_NAME"
     }
+    // Ank Plugin is not applied for every library to avoid adding runtime dependencies
     apply plugin: 'ank-gradle-plugin'
     ank {
@@ Expand Down @@