Skip to content

Debug: Restore website deployment to GitHub Pages #995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/deploy-preview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Deploy Preview for Pull Requests

on:
pull_request:
branches:
- main

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
bundler-cache: true

- name: Install dependencies
run: |
bundle install

- name: Build Jekyll site
run: |
bundle exec jekyll build --destination _site

- name: Copy site to PR-specific folder
run: |
mkdir pr_preview
mv _site pr_preview/${{ github.event.pull_request.number }}

- name: Deploy to GitHub Pages for preview
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.PR_PREVIEW_TOKEN }}
publish_branch: gh-pages
publish_dir: ./pr_preview
external_repository: open-life-science/ols-site-preview
cname: ''

- name: Comment with preview URL
env:
GITHUB_TOKEN: ${{ secrets.PR_PREVIEW_TOKEN }}
run: |
PREVIEW_URL="https://we-are-ols.org/ols-site-preview/${{ github.event.pull_request.number }}"
COMMENT_BODY="🎉 A preview of this PR is available at: [${PREVIEW_URL}](${PREVIEW_URL})"
gh pr comment ${{ github.event.pull_request.number }} --body "$COMMENT_BODY"
99 changes: 55 additions & 44 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,50 +1,61 @@
name: Deploy Preview for Pull Requests
# Workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll site to Pages

on:
pull_request:
branches:
- main
# Runs on pushes targeting the default branch
push:
branches: ["main"]

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
bundler-cache: true

- name: Install dependencies
run: |
bundle install
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

- name: Build Jekyll site
run: |
bundle exec jekyll build --destination _site
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

- name: Copy site to PR-specific folder
run: |
mkdir pr_preview
mv _site pr_preview/${{ github.event.pull_request.number }}
# 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

- name: Deploy to GitHub Pages for preview
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.PR_PREVIEW_TOKEN }}
publish_branch: gh-pages
publish_dir: ./pr_preview
external_repository: open-life-science/ols-site-preview
cname: ''

- name: Comment with preview URL
env:
GITHUB_TOKEN: ${{ secrets.PR_PREVIEW_TOKEN }}
run: |
PREVIEW_URL="http://we-are-ols.org/ols-site-preview/${{ github.event.pull_request.number }}"
COMMENT_BODY="🎉 A preview of this PR is available at: [${PREVIEW_URL}](${PREVIEW_URL})"
gh pr comment ${{ github.event.pull_request.number }} --body "$COMMENT_BODY"
jobs:
# Build job
build:
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Ruby
uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
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@v3
- 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

Loading