#23 Deploy site for each git branch

.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,103 @@
+#!/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
+}
+
+deploy() {
+  if [[ ! -z "$GITHUB_REF_NAME" ]]; then
+    # The GITHUB_REF_NAME env variable is available in github actions.
+    git_branch=$GITHUB_REF_NAME
+  else
+    git_branch=$(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/$(slugify ${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."
+}
+
+update_deployments_list() {
+  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')
+
+  deployments_list="DEPLOYMENTS.md"
+  echo "Updating ${deployments_list}"
+  rm $deployments_list
+
+  # Create a markdown table
+  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_git_branch}](https://github.com/${github_repo_owner}/${github_repo_name}/tree/${branch}) | [Open](${main_deployment_url}) |" >>$deployments_list
+
+  remote_branches=$( git ls-remote --heads origin | sed 's?.*refs/heads/??' | grep -v "gh-pages" | grep -v "${main_git_branch}")
+  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}) |" >>$deployments_list
+  done
+
+  # Update gh-pages branch
+  git add --all
+  git commit --allow-empty -m "Update ${deployments_list}"
+  git push --force origin gh-pages
+}
+
+deploy
+update_deployments_list

.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,10 @@ 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
-        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
+        run: ./.github/workflows/deploy.sh

README.md

@@ -14,9 +14,10 @@ This repository is for the [haskell.foundation](https://haskell.foundation) webs
   - [Table Of Contents](#table-of-contents)
   - [Building](#building)
   - [CI](#ci)
+  - [Deployment](#deployment)
+    - [PRs deployment](#prs-deployment)
   - [License](#license)
 
-
 ## Building
 
 To build the project:
@@ -50,6 +51,26 @@ The general steps are:
 7. Copy the `_site` directory over the `main` branch contents
 8. Commit and push the site contents to the `main` branch.
 
+## Deployment
+
+[Available Deployments](https://github.com/haskellfoundation/haskellfoundation.github.io/blob/gh-pages/DEPLOYMENTS.md)
+
+Deployment is automated for branches in the original repository.
+
+### PRs deployment
+
+When you are submitting a PR, it's a good practice to provide a link to a running website demo.
+
+First you should enable GitHub pages for you forked repository.
+
+<img width="949" alt="Screen Shot 2021-12-29 at 10 28 32 PM" src="https://user-images.githubusercontent.com/9302460/147704755-d9bc8c08-7272-4c55-b88f-34b3aefd0c1e.png">
+
+Then you should manually trigger a build for your branch in your forker repository.
+
+<img width="988" alt="Screen Shot 2021-12-29 at 10 25 19 PM" src="https://user-images.githubusercontent.com/9302460/147704589-8bce2b51-cedc-4e8a-9aec-33574b2d2c02.png">
+
+At first time it can take a while because there is no cache for Hakyll dependencies at your GitHub actions runner yet. You can attach a link to running CI job to the PR and go drink coffee.
+
 ## License
 
 This site is open source, and covered under the Apache 2.0 license.

donations/sponsors/flipstone.markdown

@@ -1,7 +1,7 @@
 ---
 title: FlipStone
-logo: /assets/images/sponsors/flipstone/flipstone-683.png
-srcset: /assets/images/sponsors/flipstone/flipstone-200.png 200w, /assets/images/sponsors/flipstone/flipstone-400.png 400w, /assets/images/sponsors/flipstone/flipstone-683.png 683w
+logo: ./assets/images/sponsors/flipstone/flipstone-683.png
+srcset: ./assets/images/sponsors/flipstone/flipstone-200.png 200w, ./assets/images/sponsors/flipstone/flipstone-400.png 400w, ./assets/images/sponsors/flipstone/flipstone-683.png 683w
 externalUrl: https://flipstone.com/
 level: Functor
 ---

donations/sponsors/github.markdown

@@ -1,7 +1,7 @@
 ---
 title: GitHub
-logo: /assets/images/sponsors/github/github-683.png
-srcset: /assets/images/sponsors/github/github-200.png 200w, /assets/images/sponsors/github/github-400.png 400w, /assets/images/sponsors/github/github-683.png 683w
+logo: ./assets/images/sponsors/github/github-683.png
+srcset: ./assets/images/sponsors/github/github-200.png 200w, ./assets/images/sponsors/github/github-400.png 400w, ./assets/images/sponsors/github/github-683.png 683w
 externalUrl: https://github.com/
 level: Monad
 ---

donations/sponsors/iohk.markdown

@@ -1,7 +1,7 @@
 ---
 title: IOHK
-logo: /assets/images/sponsors/iohk/iohk-683.png
-srcset: /assets/images/sponsors/iohk/iohk-200.png 200w, /assets/images/sponsors/iohk/iohk-400.png 400w, /assets/images/sponsors/iohk/iohk-683.png 683w
+logo: ./assets/images/sponsors/iohk/iohk-683.png
+srcset: ./assets/images/sponsors/iohk/iohk-200.png 200w, ./assets/images/sponsors/iohk/iohk-400.png 400w,   ./assets/images/sponsors/iohk/iohk-683.png 683w
 externalUrl: https://iohk.io/
 level: Monad
 ---

donations/sponsors/obsidian.markdown

@@ -1,7 +1,7 @@
 ---
 title: Obsidian Systems
-logo: /assets/images/sponsors/obsidian-systems/obsidian-systems-683.png
-srcset: /assets/images/sponsors/obsidian-systems/obsidian-systems-200.png 200w, /assets/images/sponsors/obsidian-systems/obsidian-systems-400.png 400w, /assets/images/sponsors/obsidian-systems/obsidian-systems-683.png 683w
+logo: ./assets/images/sponsors/obsidian-systems/obsidian-systems-683.png
+srcset: ./assets/images/sponsors/obsidian-systems/obsidian-systems-200.png 200w, ./assets/images/sponsors/obsidian-systems/obsidian-systems-400.png 400w, ./assets/images/sponsors/obsidian-systems/obsidian-systems-683.png 683w
 externalUrl: https://obsidian.systems/
 level: Applicative
 ---

donations/sponsors/tweag.markdown

@@ -1,7 +1,7 @@
 ---
 title: Tweag
-logo: /assets/images/sponsors/tweag/tweag-683.png
-srcset: /assets/images/sponsors/tweag/tweag-200.png 200w, /assets/images/sponsors/tweag/tweag-400.png 400w, /assets/images/sponsors/tweag/tweag-683.png 683w
+logo: ./assets/images/sponsors/tweag/tweag-683.png
+srcset: ./assets/images/sponsors/tweag/tweag-200.png 200w, ./assets/images/sponsors/tweag/tweag-400.png 400w, ./assets/images/sponsors/tweag/tweag-683.png 683w
 externalUrl: https://tweag.io/
 level: Applicative
 ---

donations/sponsors/welltyped.markdown

@@ -1,7 +1,7 @@
 ---
 title: Well-Typed
-logo: /assets/images/sponsors/well-typed/well-typed-683.png
-srcset: /assets/images/sponsors/well-typed/well-typed-200.png 200w, /assets/images/sponsors/well-typed/well-typed-400.png 400w, /assets/images/sponsors/well-typed/well-typed-683.png 683w
+logo: ./assets/images/sponsors/well-typed/well-typed-683.png
+srcset: ./assets/images/sponsors/well-typed/well-typed-200.png 200w, ./assets/images/sponsors/well-typed/well-typed-400.png 400w, ./assets/images/sponsors/well-typed/well-typed-683.png 683w
 externalUrl: https://well-typed.com/
 level: Applicative
 ---