Update for CNAME and Private Repos

README.rst

@@ -124,9 +124,9 @@ to navigate to your GitHub Pages site.
 Inputs
 ******
 
-======================  ================================================================================================
+======================  =============================================================
 Directive Name          Description (Docutils version added to, in [brackets])
-======================  ================================================================================================
+======================  =============================================================
 token                   the `GITHUB_TOKEN` secret. This is mandatory unless
                         `build_only` is set to `true`.
 sphinx_env              The Sphinx environment to build (default to `production`)
@@ -139,7 +139,8 @@ build_only              When set to `true`, the Sphinx site will be built but no
 pre_build_commands      Commands to run prior to build and deploy. Useful for
                         ensuring build dependencies are up to date or installing
                         new dependencies.
-======================  ================================================================================================
+cname                   Contents of CNAME file, this will be copied over.
+======================  =============================================================
 
 
 Example Usage:

action.yml

@@ -32,6 +32,9 @@ inputs:
       new dependencies. For example, use `apk --update add
       imagemagick` to install ImageMagick.
     required: false
+  cname:
+    description: 'contents of the CNAME file'
+    required: false
 runs:
   using: 'docker'
   image: 'Dockerfile'

entrypoint.sh

@@ -36,19 +36,53 @@ else
 fi
 
 if [ -n "${INPUT_TARGET_BRANCH}" ]; then
+  # If a target branch is provided, use it
   remote_branch="${INPUT_TARGET_BRANCH}"
   echo "::debug::target branch is set via input parameter"
 else
-  response=$(curl -sH "Authorization: token ${INPUT_TOKEN}" \
-                  "https://api.github.com/repos/${GITHUB_REPOSITORY}/pages")
-  remote_branch=$(echo "$response" | awk -F'"' '/\"branch\"/ { print $4 }')
-  if [ -z "${remote_branch}" ]; then
-    echo "::error::Cannot get GitHub Pages source branch via API."
-    echo "::error::${response}"
+  # Figure out the GH Pages branch. Only if its a public repo.
+  repo_details_response=$(curl -sH "Authorization: token ${INPUT_TOKEN}" \
+    "https://api.github.com/repos/${GITHUB_REPOSITORY}")
+  is_private=$(echo "$repo_details_response" | awk -F'[:,]' '/\"private\"/ { print $2 }')
+  echo "::debug::Is this repo private? ${is_private}"
+  if [ -z "${is_private}" ]; then
+    echo "::error::Cannot get repository visibility via API."
+    echo "::error::${repo_details_response}"
     exit 1
+  elif [ $is_private = false ]; then
+    # This is a public repo. Getting the Pages settings
+    remote_branch_response=$(curl -sH "Authorization: token ${INPUT_TOKEN}" \
+                  "https://api.github.com/repos/${GITHUB_REPOSITORY}/pages")
+    remote_branch=$(echo "$remote_branch_response" | awk -F'"' '/\"branch\"/ { print $4 }')
+    echo "::debug::Pages' branch from settings is ${remote_branch}"
+
+    if [ -z "${remote_branch}" ]; then
+      echo "::error::Cannot get GitHub Pages source branch via API."
+      echo "::error::${remote_branch_response}"
+      exit 1
+    fi
+  else
+    # This is a private repo.
+    # Is this a regular repo or an org.github.io type of repo
+    case "${GITHUB_REPOSITORY}" in
+      *.github.io)
+        default_branch=$(echo "$repo_details_response" | awk -F'"' '/\"default_branch\\"/ { print $4 }')
+        echo "::debug::Repo default branch is ${default_branch}"
+
+        if [ -z "${default_branch}" ]; then
+          echo "::error::Cannot get the default branch via API."
+          echo "::error::${default_branch_response}"
+          exit 1
+        fi
+        remote_branch=$default_branch ;;
+      *)
+        remote_branch="gh-pages" ;;
+    esac
   fi
 fi
 
+echo "::debug::Remote branch is ${remote_branch}"
+
 REMOTE_REPO="https://${GITHUB_ACTOR}:${INPUT_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
 echo "::debug::Remote is ${REMOTE_REPO}"
 BUILD_DIR="${GITHUB_WORKSPACE}/../sphinx_build"
@@ -111,6 +145,10 @@ fi
 
 cd ${BUILD_DIR}
 
+if [ -n "${INPUT_CNAME}" ]; then
+  echo $INPUT_CNAME > CNAME
+fi
+
 # No need to have GitHub Pages to run Jekyll
 touch .nojekyll