GeezerVison is showing github.com — utPLSQL/.github/scripts/push_docs_to_github_io.sh at develop · bozo030/utPLSQL

Expand file tree

push_docs_to_github_io.sh

Copy path

More file actions

Latest commit

History

executable file

92 lines (80 loc) · 3.44 KB

push_docs_to_github_io.sh

Copy path

File metadata and controls

executable file

92 lines (80 loc) · 3.44 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

#!/bin/bash

# Based on `push_docs_to_gh_pages.sh`

# Significant alterations

# - Support for multiple copies of documentation,

# - only clearing out develop

# - index.md logging doc history

# How to run:

# - From repository root .github/scripts/push_docs_to_gh_pages.sh

# Required files / directories (relative from repo root)

# - File: "docs/index.md" with that contains develop docs

# Required ENV Variables

LATEST_DOCS_BRANCH="develop"

GITHUB_IO_REPO='utPLSQL/utPLSQL.github.io'

GITHUB_IO_BRANCH='main'

DOCS_DIR='../../docs/.'

# 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; }

# 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} .

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_DIR} ./develop

# 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_DIR} ./${UTPLSQL_VERSION}

echo "Populating 'latest' directory"

mkdir -p ./latest

rm -rf ./latest/**./* || exit 0

cp -a ${DOCS_DIR} ./latest

# 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

#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 "" >>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

#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 ${CI_ACTION_REF_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'" - [${CI_ACTION_REF_NAME} documentation](${UTPLSQL_VERSION}/) - Created $now" index.md

#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}