Update release process documentation to include PR preview deployment #5
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
name: Deploy PR CI | |
on: | |
pull_request: | |
types: | |
- opened | |
- reopened | |
- synchronize | |
- closed | |
paths: | |
- "docs/**" | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: write | |
pull-requests: write | |
jobs: | |
deploy-preview: | |
name: Deploy website PR review | |
concurrency: preview-${{ github.ref }} | |
runs-on: ubuntu-latest | |
env: | |
BASEURL: /pr-preview/pr-${{ github.event.number }} | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Ruby | |
uses: ruby/setup-ruby@v1 | |
with: | |
ruby-version: '3.3' | |
bundler-cache: true | |
working-directory: '${{ github.workspace }}/docs' | |
- name: Build static site | |
run: bundle exec jekyll build --baseurl ${{ env.BASEURL }} | |
- name: Upload artifact | |
# Automatically uploads an artifact from the './_site' directory by default | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: ${{ env.BASEURL }} | |
- name: Deploy preview | |
uses: rossjrw/pr-preview-action@v1 | |
with: | |
source-dir: ./docs/ | |
preview-branch: main | |
umbrella-dir: docs/pr-preview |