Testing publishing of documentation to gh-pages

utPLSQL · jgebal · Jan 14, 2022 · Nov 24, 2021 · Nov 24, 2021 · Nov 25, 2021
commit 82c4d21a97c29d6fa85df65d9688ad1b70e4677f
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -209,6 +209,24 @@ jobs:
              ) 
           }}
 
+      - name: Copy and push documentation to utPLSQL-github-io repo
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        run: .travis/push_docs_to_github_io.sh
+        shell: bash
+        if:  |
+          ${{ 
+            github.repository == 'utPLSQL/utPLSQL'
+            && (github.ref_type == 'branch'
+              && ( startsWith(env.CURRENT_BRANCH,'release/') 
+                || env.CURRENT_BRANCH == 'develop'
+                || env.CURRENT_BRANCH == 'feature/github_actions'  
+              )
+              || github.ref_type == 'tag'
+            )
+          }}
+
+
 
 # TODO - add slack notifications
 # TODO - add push of documentation

diff --git a/.travis/push_docs_to_github_io.sh b/.travis/push_docs_to_github_io.sh
@@ -17,81 +17,79 @@ LATEST_DOCS_BRANCH="develop"
 GITHUB_IO_REPO='utPLSQL/utPLSQL.github.io'
 GITHUB_IO_BRANCH='main'
 
-#  TRAVIS_* variables are set by travis directly and only need to be if testing externally
 
-# We deploy only when building on develop branch or on TAG (release)
-if [ "${PULL_REQUEST_NAME}" == "false" ] && { [ "${CURRENT_BRANCH}" == "${LATEST_DOCS_BRANCH}" ] || [ -n "${TAG_NAME}" ]; }; then
+# ENV Variable checks are to help with configuration troubleshooting, they silently exit with unique message.
+# Anyone one of them not set can be used to turn off this functionality.
 
-  # ENV Variable checks are to help with configuration troubleshooting, they silently exit with unique message.
-  # Anyone one of them not set can be used to turn off this functionality.
+# If a version of the project is not defined
+[[ -n "${UTPLSQL_VERSION}" ]] || { echo "variable UTPLSQL_VERSION is not defines or missing value";  exit 1; }
+# Fail if the markdown documentation is not present.
+[[ -f ./docs/index.md ]] || { echo "file docs/index.md not found";  exit 1; }
 
-  # If a version of the project is not defined
-  [[ -n "${UTPLSQL_VERSION}" ]] || { echo "variable UTPLSQL_VERSION is not defines or missing value";  exit 1; }
-  # Fail if the markdown documentation is not present.
-  [[ -f ./docs/index.md ]] || { echo "file docs/index.md not found";  exit 1; }
+# Store latest commit SHA to be used when committing and pushing to github.io repo
+SHA=`git rev-parse --verify HEAD`
 
-  # Store latest commit SHA to be used when committing and pushing to github.io repo
-  SHA=`git rev-parse --verify HEAD`
+# clone the repository and switch to GITHUB_IO_BRANCH branch
+mkdir pages
+cd ./pages
+git clone --depth 1 https://${API_TOKEN_GITHUB}@github.com/${GITHUB_IO_REPO} -b ${GITHUB_IO_BRANCH} .
 
-  # clone the repository and switch to GITHUB_IO_BRANCH branch
-  mkdir pages
-  cd ./pages
-  git clone --depth 1 https://${github_api_token}@github.com/${GITHUB_IO_REPO} -b ${GITHUB_IO_BRANCH} .
+git config user.email "github-actions[bot]@users.noreply.github.com"
+git config user.name "github-actions[bot]"
 
-  mkdir -p utPLSQL
-  cd ./utPLSQL
-  #clear out develop documentation directory and copy docs contents to it.
-  echo "updating 'develop' documentation directory"
-  mkdir -p ./develop
-  rm -rf ./develop/**./* || exit 0
-  cp -a ../../docs/. ./develop
+mkdir -p utPLSQL
+cd ./utPLSQL
+#clear out develop documentation directory and copy docs contents to it.
+echo "updating 'develop' documentation directory"
+mkdir -p ./develop
+rm -rf ./develop/**./* || exit 0
+cp -a ../../docs/. ./develop
 
-  # If a Tagged Build then copy to it's own directory as well and to the 'latest' release directory
-  if [ -n "${TAG_NAME}" ]; then
-    echo "Creating directory ./${UTPLSQL_VERSION}"
-    mkdir -p ./${UTPLSQL_VERSION}
-    rm -rf ./${UTPLSQL_VERSION}/**./* || exit 0
-    cp -a ../../docs/. ./${UTPLSQL_VERSION}
-    echo "Populating 'latest' directory"
-    mkdir -p ./latest
-    rm -rf ./latest/**./* || exit 0
-    cp -a ../../docs/. ./latest
-  fi
-  # Stage changes for commit
-  git add .
+# If a Tagged Build then copy to it's own directory as well and to the 'latest' release directory
+if [ "${GITHUB_REF_TYPE}" == "tag" ]; then
+  echo "Creating directory ./${UTPLSQL_VERSION}"
+  mkdir -p ./${UTPLSQL_VERSION}
+  rm -rf ./${UTPLSQL_VERSION}/**./* || exit 0
+  cp -a ../../docs/. ./${UTPLSQL_VERSION}
+  echo "Populating 'latest' directory"
+  mkdir -p ./latest
+  rm -rf ./latest/**./* || exit 0
+  cp -a ../../docs/. ./latest
+fi
+# Stage changes for commit
+git add .
 
-  #Check if there are doc changes, if none exit the script
-  if [[ -z `git diff HEAD --exit-code` ]]; then
-    echo "No changes to docs detected."
-    exit 0
-  fi
-  #Changes where detected, so we need to update the version log.
-  now=$(date +"%d %b %Y - %r")
-  if [ ! -f index.md ]; then
-    echo "---" >>index.md
-    echo "layout: default" >>index.md
-    echo "---" >>index.md
-    echo "<!-- Auto generated from .travis/push_docs_to_github_io.sh -->" >>index.md
-    echo "# Documentation versions" >>index.md
-    echo "" >>index.md
-    echo "" >>index.md #- 7th line - placeholder for latest release doc
-    echo "" >>index.md #- 8th line - placeholder for develop branch doc
-    echo "" >>index.md
-    echo "## Released Version Doc History" >>index.md
-    echo "" >>index.md
-  fi
-  #If build running on a TAG - it's a new release - need to add it to documentation
-  if [ -n "${TAG_NAME}" ]; then
-    sed -i '7s@.*@'" - [Latest ${TAG_NAME} documentation](latest/) - Created $now"'@' index.md
-    #add entry to the top of version history (line end of file - ## Released Version Doc History
-    sed -i '12i'" - [${TAG_NAME} documentation](${UTPLSQL_VERSION}/) - Created $now" index.md
-  fi
-  #replace 4th line in log
-  sed -i '8s@.*@'" - [Latest development version](develop/) - Created $now"'@'  index.md
-  #Add and Commit the changes back to pages repo.
-  git add .
-  git commit -m "Deploy to gh-pages branch: base commit ${SHA}"
-  # Now that we're all set up, we can push.
-  git push --quiet origin HEAD:${GITHUB_IO_BRANCH}
+#Check if there are doc changes, if none exit the script
+if [[ -z `git diff HEAD --exit-code` ]]; then
+  echo "No changes to docs detected."
+  exit 0
+fi
+#Changes where detected, so we need to update the version log.
+now=$(date +"%d %b %Y - %r")
+if [ ! -f index.md ]; then
+  echo "---" >>index.md
+  echo "layout: default" >>index.md
+  echo "---" >>index.md
+  echo "<!-- Auto generated from .travis/push_docs_to_github_io.sh -->" >>index.md
+  echo "# Documentation versions" >>index.md
+  echo "" >>index.md
+  echo "" >>index.md #- 7th line - placeholder for latest release doc
+  echo "" >>index.md #- 8th line - placeholder for develop branch doc
+  echo "" >>index.md
+  echo "## Released Version Doc History" >>index.md
+  echo "" >>index.md
+fi
+#If build running on a TAG - it's a new release - need to add it to documentation
+if [ "${GITHUB_REF_TYPE}" == "tag" ]; then
+  sed -i '7s@.*@'" - [Latest ${CURRENT_BRANCH} documentation](latest/) - Created $now"'@' index.md
+  #add entry to the top of version history (line end of file - ## Released Version Doc History
+  sed -i '12i'" - [${CURRENT_BRANCH} documentation](${UTPLSQL_VERSION}/) - Created $now" index.md
 fi
+#replace 4th line in log
+sed -i '8s@.*@'" - [Latest development version](develop/) - Created $now"'@'  index.md
+#Add and Commit the changes back to pages repo.
+git add .
+git commit -m "Deploy to gh-pages branch: base commit ${SHA}"
+# Now that we're all set up, we can push.
+git push --quiet origin HEAD:${GITHUB_IO_BRANCH}