fix(cd/github): Fix incorrect footer credit on GitHub Pages #21
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# GitHub Actions workflow for deploying Jekyll site to GitHub Pages | |
# | |
# References: | |
# | |
# * Workflow syntax for GitHub Actions - GitHub Docs | |
# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions | |
# | |
# Copyright 2024 林博仁(Buo-ren Lin) <[email protected]> | |
# SPDX-License-Identifier: CC-BY-SA-4.0 | |
name: Deploy Jekyll site to GitHub Pages | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: | |
- main | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: pages | |
cancel-in-progress: false | |
jobs: | |
# Build job | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Ruby | |
uses: ruby/setup-ruby@v1 | |
with: | |
ruby-version: '3' | |
bundler-cache: true # runs 'bundle install' and caches installed gems automatically | |
cache-version: 0 # Increment this number if you need to re-download cached gems | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v5 | |
- name: Patch site information | |
run: |- | |
sed_common_opts=( | |
--in-place | |
--regexp-extended | |
) | |
sed_opts=( | |
"${sed_common_opts[@]}" | |
--expression='s@resume\.brlin\[email protected]@' | |
--expression="s@^baseurl: ''@baseurl: '/resume'@" | |
) | |
if ! sed "${sed_opts[@]}" _config.yml; then | |
printf \ | |
'Error: Unable to patch the Jekyll configuration file.\n' \ | |
1>&2 | |
exit 2 | |
fi | |
sed_opts=( | |
"${sed_common_opts[@]}" | |
--expression='s@https://docs\.gitlab\.com/ee/user/project/pages/@https://pages.github.com/@' | |
--expression='s@GitLab Pages@GitHub Pages@' | |
) | |
if ! sed "${sed_opts[@]}" _includes/footer-custom.*.html; then | |
printf \ | |
'Error: Unable to patch the page footer.\n' \ | |
1>&2 | |
exit 2 | |
fi | |
- name: Build with Jekyll | |
# Outputs to the './_site' directory by default | |
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" | |
env: | |
JEKYLL_ENV: production | |
- name: Upload artifact | |
# Automatically uploads an artifact from the './_site' directory by default | |
uses: actions/upload-pages-artifact@v3 | |
# Deployment job | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |