correct typo in server name for documentation #1495
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: Build, test, and upload docs | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
types: [opened, reopened, synchronize, ready_for_review] | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
permissions: | |
contents: write | |
jobs: | |
build-test-doc: | |
runs-on: ubuntu-latest | |
timeout-minutes: 20 | |
if: github.repository_owner == 'fritz-marshal' && github.event.pull_request.draft == false | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
- uses: actions/setup-node@v3 | |
with: | |
node-version: 20 | |
- uses: actions/cache@v4 | |
with: | |
path: | | |
~/.npm | |
key: ${{ runner.os }}-npm-${{ hashFiles('package.json') }} | |
- uses: actions/cache@v4 | |
with: | |
path: | | |
~/.cache/pip | |
key: ${{ runner.os }}-${{ hashFiles('**/requirements*.txt') }} | |
# caching dustmap & sncosmo files is dependent on their corresponding | |
# python package versions, so we use that as the cache key | |
- uses: actions/cache@v4 | |
with: | |
path: | | |
persistentdata/dustmap/sfd | |
key: ${{ runner.os }}-dustmap-${{ hashFiles('**/requirements*.txt') }} | |
restore-keys: | | |
${{ runner.os }}-dustmap-${{ hashFiles('**/requirements*.txt') }} | |
${{ runner.os }}-dustmap- | |
- uses: actions/cache@v4 | |
with: | |
path: | | |
~/.astropy/cache/sncosmo/bandpasses | |
key: ${{ runner.os }}-sncosmo-${{ hashFiles('**/requirements*.txt') }} | |
restore-keys: | | |
${{ runner.os }}-sncosmo-${{ hashFiles('**/requirements*.txt') }} | |
${{ runner.os }}-sncosmo- | |
- name: Install system dependencies | |
run: | | |
sudo apt update -y && sudo apt install -y libcurl4-gnutls-dev libgnutls28-dev | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt | |
./fritz develop | |
- name: Lint sources | |
run: | | |
./fritz lint | |
- name: Build docs | |
run: | | |
pip install wheel | |
pip install -r skyportal/requirements.txt | |
pip install -r skyportal/baselayer/requirements.txt | |
./fritz doc --yes | |
- name: Deploy docs | |
if: github.ref == 'refs/heads/main' | |
uses: JamesIves/github-pages-deploy-action@v4.6.1 | |
with: | |
folder: doc/_build/html | |
repository-name: fritz-marshal/doc | |
branch: main | |
ssh-key: ${{ secrets.CI_DEPLOY_KEY }} |