haskellfoundation#23 Make a site deployment per branch

Author: visortelle

.github/workflows/deploy.sh

@@ -17,11 +17,7 @@ slugify() {
   echo "$1" | iconv -c -t ascii//TRANSLIT | sed -E 's/[~^]+/-/g' | sed -E 's/[^a-zA-Z0-9]+/-/g' | sed -E 's/^-+|-+$/-/g' | tr A-Z a-z
 }
 
-if [[ ! -z "$GITHUB_ACTIONS" ]]; then
-  git_branch=$(slugify "$GITHUB_REF_NAME")
-else
-  git_branch=$(slugify $(git branch --show-current))
-fi
+git_branch=$(git branch --show-current)
 echo "Current git branch is '${git_branch}'."
 
 git config user.name github-actions
@@ -44,7 +40,7 @@ if [ "$git_branch" == "$main_git_branch" ]; then
   # Restore temporary backup for other branches content.
   mv ./branches "${gh_pages_root}/"
 else
-  site_dest="${gh_pages_root}/branches/${git_branch}"
+  site_dest="${gh_pages_root}/branches/$(slugify ${git_branch})"
 
   # Replace site files.
   rm -rf "${site_dest}"
@@ -58,12 +54,6 @@ git commit --allow-empty -m "[$(date '+%F %T %Z')] Updated site for the '${git_b
 git push --force origin gh-pages
 echo "Deployment finished."
 
-echo "Publishing an URL to the deployment. It will be visible as a link at GitHub in the red/green commit checks, near CI jobs result."
-if [[ -z GITHUB_TOKEN ]]; then
-  echo "GITHUB_TOKEN env variable must be provided."
-  exit 1
-fi
-
 github_project_url=$(git remote get-url origin)
 if [[ $github_project_url == [email protected]:* ]]; then
   github_repo=$(echo ${github_project_url#"[email protected]:"} | sed 's/\.git$//g')
@@ -73,33 +63,32 @@ fi
 
 github_repo_owner=$(echo "${github_repo}" | sed 's/\/.*$//g')
 github_repo_name=$(echo "${github_repo}" | sed 's/^.*\///g')
-git_head_sha=$(git rev-parse --verify HEAD)
-
-if [ "$git_branch" == "$main_git_branch" ]; then
-  deployment_url="https://${github_repo_owner}.github.io/${github_repo_name}/"
-else
-  deployment_url="https://${github_repo_owner}.github.io/${github_repo_name}/branches/${git_branch}"
-fi
 
-update_github_deployment_req_data() {
-  cat <<EOF
-{
-  "name": "deployment",
-  "ref": "${git_branch}",
-  "environment": "github-pages",
-  "payload": "some payload https://xyz.abc",
-  "description": "some description https://abc.xyz"
+update_deployments_list() {
+  deployments_list="DEPLOYMENTS.md"
+  echo "Updating ${deployments_list}"
+  rm $deployments_list
+
+  touch $deployments_list
+  echo "# Deployments" >>$deployments_list
+  echo "" >>$deployments_list
+  echo "| Branch | Link |" >>$deployments_list
+  echo "| --- | --- |" >>$deployments_list
+
+  main_deployment_url="https://${github_repo_owner}.github.io/${github_repo_name}/"
+  echo "| [main](https://github.com/${github_repo_owner}/${github_repo_name}/tree/${branch}) | [Open](${main_deployment_url}) |"
+
+  remote_branches=$(git ls-remote --heads origin | sed 's?.*refs/heads/??')
+  echo "$remote_branches" | while IFS= read -r branch; do
+    safe_branch=$(slugify $branch)
+    deployment_url="https://${github_repo_owner}.github.io/${github_repo_name}/branches/${safe_branch}"
+    echo "| [${branch}](https://github.com/${github_repo_owner}/${github_repo_name}/tree/${branch}) | [Open](${deployment_url}) |"
+  done
+
+  # Update gh-pages branch
+  git add --all
+  git commit --allow-empty -m "Update ${deployments_list}"
+  git push --force origin gh-pages
 }
-EOF
-}
-
-curl -i \
-  --header "Authorization: Bearer ${GITHUB_TOKEN}" \
-  --header "Accept: application/vnd.github.v3+json" \
-  --header "User-Agent: github-actions" \
-  --header "Content-Type: application/json" \
-  --data "$(update_github_deployment_req_data)" \
-  --fail \
-  https://api.github.com/repos/${github_repo_owner}/${github_repo_name}/deployments
 
-echo "Deployment is available at: '${deployment_url}'"
+update_deployments_list

.github/workflows/main.yml

@@ -57,7 +57,4 @@ jobs:
           stack exec --system-ghc site build
 
       - name: Deploy
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          ./.github/workflows/deploy.sh
+        run: ./.github/workflows/deploy.sh