haskellfoundation#23 Deploy site for each git branch

Author: visortelle

.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
+# More: https://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[Makefile]
+indent_style = tab

.github/workflows/deploy.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+
+# Deploy static site to the GitHub pages.
+
+set -eo pipefail
+
+git_repo_root=$(git rev-parse --show-toplevel)
+site_src="${git_repo_root}/_site"
+gh_pages_root="${git_repo_root}/docs"
+
+# Site built from the main branch will be available at 'https://<domain_name>/'.
+# Sites built from other branchs will be available at 'https://<domain_name>/branches/<branch_name>'.
+main_git_branch="hakyll"
+
+# replace "/", "#", etc with "-".
+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
+echo "Current git branch is '${git_branch}'."
+
+git config user.name github-actions
+git config user.email [email protected]
+
+git checkout gh-pages
+git pull origin gh-pages
+
+if [ "$git_branch" == "$main_git_branch" ]; then
+  site_dest="${gh_pages_root}"
+
+  # Create temporary backup for other branches content.
+  mv "${gh_pages_root}/branches" .
+
+  # Replace site files.
+  rm -rf "${site_dest}"
+  mkdir -p "${site_dest}"
+  cp -a -v ${site_src}/* ${site_dest}/
+
+  # Restore temporary backup for other branches content.
+  mv ./branches "${gh_pages_root}/"
+else
+  site_dest="${gh_pages_root}/branches/${git_branch}"
+
+  # Replace site files.
+  rm -rf "${site_dest}"
+  mkdir -p "${site_dest}"
+  cp -a -v ${site_src}/* ${site_dest}/
+fi
+
+echo "Updating gh-pages branch."
+git add --all
+git commit --allow-empty -m "[$(date '+%F %T %Z')] Updated site for the '${git_branch}' branch [ci skip]"
+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')
+elif [[ $github_project_url == https://github.com/* ]]; then
+  github_repo=$(echo ${github_project_url#"https://github.com/"} | sed 's/\.git$//g' | sed 's/^\/\///g')
+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_checks_json()
+{
+  cat <<EOF
+{
+  "name": "deployment",
+  "head_sha": "${git_head_sha}",
+  "status": "completed",
+  "conclusion": "success",
+  "details_url": "${deployment_url}"
+}
+EOF
+}
+
+curl \
+  --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_checks_json)" \
+  --fail \
+  https://api.github.com/repos/${github_repo_owner}/${github_repo_name}/check-runs
+
+
+echo "Deployment is available at: '${deployment_url}'"

.github/workflows/main.yml

@@ -6,9 +6,12 @@ name: CI
 on:
   # Triggers the workflow on push or pull request events but only for the hakyll branch
   push:
-    branches: [ hakyll ]
+    # branches:
+    branches-ignore:
+      - gh-pages
   pull_request:
-    branches: [ hakyll ]
+    branches-ignore:
+      - gh-pages
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -48,21 +51,13 @@ jobs:
       - name: Build dependencies
         run: stack build --system-ghc --only-dependencies
 
-      - name: Build site executable
-        run: stack build --system-ghc
+      - name: Build
+        run: |
+          stack build --system-ghc
+          stack exec --system-ghc site build
 
-      # Runs a set of commands using the runners shell
       - name: Deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-            git config user.name github-actions
-            git config user.email [email protected]
-            stack exec --system-ghc site rebuild
-            git checkout main
-            git pull --rebase
-            # Overwrite existing files with new files
-            cp -a -v _site/. .
-            #  Commit
-            git add --all
-            git commit -m "[`date '+%F %T %Z'`] New release [ci skip]"
-            # Push
-            git push origin main:main
+          ./.github/workflows/deploy.sh