Skip to content

Commit

Permalink
Add workflow to build the site with Jekyll and deploy using ltd-upload
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyMcCormick committed Jul 29, 2024
1 parent 6a7b8c7 commit c4c5cdc
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Python CI

env:
# Default Python version used for all jobs other than test, which uses a
# matrix of supported versions. Quote the version to avoid interpretation as
# a floating point number.
PYTHON_VERSION: "3.12"

"on":
merge_group: {}
pull_request: {}
push:
branches-ignore:
# These should always correspond to pull requests, so ignore them for
# the push trigger and let them be triggered by the pull_request
# trigger, avoiding running the workflow twice. This is a minor
# optimization so there's no need to ensure this is comprehensive.
- "dependabot/**"
- "gh-readonly-queue/**"
- "renovate/**"
- "tickets/**"
- "u/**"
release:
types: [published]

jobs:

docs:

runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # full history for setuptools_scm

Check warning on line 36 in .github/workflows/docs.yaml

View workflow job for this annotation

GitHub Actions / call-workflow / yamllint

36:26 [comments] too few spaces before comment

- name: Install Ruby and other prerequisites
run: sudo apt-get install ruby-full build-essential zlib1g-dev

- name: Install Jekyll
run: gem install bundler jekyll

- name: Setup Ruby Gems environment
run: |
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
- name: Build the schema browser site
run: jekyll build

# Only attempt documentation uploads for tagged releases and pull
# requests from ticket branches in the same repository. This avoids
# version clutter in the docs and failures when a PR doesn't have access
# to secrets.
- name: Upload to LSST the Docs
uses: lsst-sqre/ltd-upload@v1
with:
project: "sdm-schemas"
dir: "_site"
username: ${{ secrets.LTD_USERNAME }}
password: ${{ secrets.LTD_PASSWORD }}
if: >
github.event_name != 'merge_group'
&& (github.event_name != 'pull_request'
|| startsWith(github.head_ref, 'tickets/'))

0 comments on commit c4c5cdc

Please sign in to comment.