Skip to content

Commit

Permalink
use reusable workflow from WebbPSF repository to download and cache d…
Browse files Browse the repository at this point in the history
…ata (#1311)

Co-authored-by: Eddie Schlafly <[email protected]>
  • Loading branch information
zacharyburnett and schlafly authored Jul 25, 2024
1 parent d4e2d88 commit 52a6ce9
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 94 deletions.
97 changes: 28 additions & 69 deletions .github/workflows/data.yml
Original file line number Diff line number Diff line change
@@ -1,77 +1,36 @@
name: download and cache data

on:
workflow_call:
outputs:
path:
value: ${{ jobs.path.outputs.path }}
webbpsf_path:
value: ${{ jobs.webbpsf_path.outputs.path }}
webbpsf_hash:
value: ${{ jobs.webbpsf_hash.outputs.hash }}
workflow_dispatch:
schedule:
- cron: "42 4 * * 3"

env:
DATA_PATH: /tmp/data
workflow_dispatch:
inputs:
webbpsf_minimal:
description: minimal WebbPSF dataset
type: boolean
required: false
default: true

jobs:
path:
runs-on: ubuntu-latest
outputs:
path: ${{ steps.path.outputs.path }}
steps:
- id: path
run: echo "path=${{ env.DATA_PATH }}" >> $GITHUB_OUTPUT
webbpsf_path:
needs: [ path ]
download_webbpsf_data:
uses: spacetelescope/webbpsf/.github/workflows/download_data.yml@develop
with:
minimal: ${{ github.event_name != 'workflow_dispatch' && true || inputs.webbpsf_minimal }}
move_data_cache_path:
needs: [ download_webbpsf_data ]
runs-on: ubuntu-latest
outputs:
path: ${{ steps.path.outputs.path }}
steps:
- id: path
run: echo "path=${{ needs.path.outputs.path }}/webbpsf-data" >> $GITHUB_OUTPUT
webbpsf_data:
if: (github.repository == 'spacetelescope/romancal' && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'update webbpsf data')))
needs: [ path, webbpsf_path ]
name: download and cache WebbPSF data
runs-on: ubuntu-latest
env:
WEBBPSF_DATA_URL: https://stsci.box.com/shared/static/qxpiaxsjwo15ml6m4pkhtk36c9jgj70k.gz
steps:
- run: mkdir -p tmp/data
- run: wget ${{ env.WEBBPSF_DATA_URL }} -O tmp/webbpsf-data.tar.gz
- id: data_hash
run: echo "hash=$( shasum tmp/webbpsf-data.tar.gz | cut -d ' ' -f 1 )" >> $GITHUB_OUTPUT
- id: cache_check
uses: actions/cache@v4
- name: retrieve cached WebbPSF data
uses: actions/cache/restore@v4
with:
path: ${{ needs.path.outputs.path }}
key: webbpsf-${{ steps.data_hash.outputs.hash }}
- if: ${{ steps.cache_check.outputs.cache-hit != 'true' }}
run: mkdir -p ${{ needs.path.outputs.path }}
- if: ${{ steps.cache_check.outputs.cache-hit != 'true' }}
run: tar -xzvf tmp/webbpsf-data.tar.gz -C ${{ needs.path.outputs.path }}
webbpsf_hash:
needs: [ webbpsf_path, webbpsf_data ]
# run data job if webbpsf-data succeeds or is skipped. This allows
# this data job to always fetch the crds context even if the webbpsf data fetching
# was skipped (and an existing cache will be used for the webbpsf data).
if: always() && (needs.webbpsf_data.result == 'success' || needs.webbpsf_data.result == 'skipped')
name: retrieve latest data cache key
runs-on: ubuntu-latest
env:
GH_TOKEN: ${{ github.token }}
outputs:
hash: ${{ steps.hash.outputs.hash }}
steps:
- id: hash
run: |
# use actions/gh-actions-cache to allow filtering by key
gh extension install actions/gh-actions-cache
RECENT=$(gh actions-cache list -R spacetelescope/romancal --key webbpsf- --sort created-at | cut -f 1 | head -n 1)
echo "RECENT=$RECENT"
HASH=$(echo $RECENT | cut -d '-' -f 2)
echo "HASH=$HASH"
echo "hash=$HASH" >> $GITHUB_OUTPUT
if [ "$HASH" == '' ]; then exit 1; fi
path: ${{ needs.download_webbpsf_data.outputs.cache_path }}
key: ${{ needs.download_webbpsf_data.outputs.cache_key }}
- run: mkdir -p /tmp/data/
- run: mv ${{ needs.download_webbpsf_data.outputs.cache_path }}/webbpsf-data/ /tmp/data/
- run: echo WEBBPSF_PATH=/tmp/data/webbpsf-data/ >> $GITHUB_ENV
# save a new cache to the generalized data directory
- name: save a single combined data cache
uses: actions/cache/save@v4
with:
path: /tmp/data/
key: ${{ needs.download_webbpsf_data.outputs.cache_key }}
18 changes: 10 additions & 8 deletions .github/workflows/roman_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,21 @@ jobs:
with:
envs: |
- linux: check-dependencies
data:
uses: ./.github/workflows/data.yml
webbpsf_data_cache:
uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@develop
with:
minimal: true
crds_contexts:
uses: spacetelescope/crds/.github/workflows/contexts.yml@master
test:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
needs: [ data, crds_contexts ]
needs: [ webbpsf_data_cache, crds_contexts ]
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
with:
setenv: |
WEBBPSF_PATH: ${{ needs.data.outputs.webbpsf_path }}
CRDS_PATH: ${{ needs.data.outputs.path }}/crds_cache
WEBBPSF_PATH: /tmp/data/webbpsf-data/
CRDS_PATH: /tmp/data/crds_cache/
CRDS_SERVER_URL: https://roman-crds.stsci.edu
CRDS_CLIENT_RETRY_COUNT: 3
CRDS_CLIENT_RETRY_DELAY_SECONDS: 20
Expand All @@ -46,9 +48,9 @@ jobs:
DD_GIT_REPOSITORY_URL: ${{ github.repositoryUrl }}
DD_GIT_COMMIT_SHA: ${{ github.sha }}
DD_GIT_BRANCH: ${{ github.ref_name }}
cache-path: ${{ needs.data.outputs.path }}
cache-key: data-${{ needs.data.outputs.webbpsf_hash }}-${{ needs.crds_contexts.outputs.roman }}
cache-restore-keys: webbpsf-${{ needs.data.outputs.webbpsf_hash }}
cache-path: /tmp/data/
cache-key: data-${{ needs.webbpsf_data_cache.outputs.cache_key }}-${{ needs.crds_contexts.outputs.roman }}
cache-restore-keys: ${{ needs.webbpsf_data_cache.outputs.cache_key }}
envs: |
- linux: py310-oldestdeps-webbpsf-cov
pytest-results-summary: true
Expand Down
19 changes: 11 additions & 8 deletions .github/workflows/roman_ci_cron.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,29 @@ concurrency:
cancel-in-progress: true

jobs:
data:
webbpsf_data_cache:
if: (github.repository == 'spacetelescope/romancal' && (github.event_name == 'schedule' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run scheduled tests')))
uses: ./.github/workflows/data.yml
uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@develop
with:
minimal: true
crds_contexts:
if: (github.repository == 'spacetelescope/romancal' && (github.event_name == 'schedule' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run scheduled tests')))
uses: spacetelescope/crds/.github/workflows/contexts.yml@master
test:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
needs: [ data, crds_contexts ]
needs: [ webbpsf_data_cache, crds_contexts ]
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
with:
setenv: |
WEBBPSF_PATH: ${{ needs.data.outputs.webbpsf_path }}
CRDS_PATH: ${{ needs.data.outputs.path }}/crds_cache
WEBBPSF_PATH: /tmp/data/webbpsf-data/
CRDS_PATH: /tmp/data/crds_cache/
CRDS_SERVER_URL: https://roman-crds.stsci.edu
CRDS_CLIENT_RETRY_COUNT: 3
CRDS_CLIENT_RETRY_DELAY_SECONDS: 20
cache-path: ${{ needs.data.outputs.path }}
cache-key: data-${{ needs.data.outputs.webbpsf_hash }}-${{ needs.crds_contexts.outputs.roman }}
cache-restore-keys: webbpsf-${{ needs.data.outputs.webbpsf_hash }}
cache-path: /tmp/data/
cache-key: data-${{ needs.webbpsf_data_cache.outputs.cache_key }}-${{ needs.crds_contexts.outputs.roman }}
cache-restore-keys: ${{ needs.webbpsf_data_cache.outputs.cache_key }}
envs: |
- macos: py310-webbpsf
pytest-results-summary: true
Expand Down
19 changes: 10 additions & 9 deletions .github/workflows/tests_devdeps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,27 @@ concurrency:
cancel-in-progress: true

jobs:
data:
webbpsf_data_cache:
if: (github.repository == 'spacetelescope/romancal' && (github.event_name == 'schedule' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run devdeps tests')))
uses: ./.github/workflows/data.yml
uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@develop
with:
minimal: true
crds_contexts:
if: (github.repository == 'spacetelescope/romancal' && (github.event_name == 'schedule' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run devdeps tests')))
uses: spacetelescope/crds/.github/workflows/contexts.yml@master
test:
if: (github.repository == 'spacetelescope/romancal' && (github.event_name == 'schedule' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run devdeps tests')))
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
needs: [ data, crds_contexts ]
needs: [ webbpsf_data_cache, crds_contexts ]
with:
setenv: |
WEBBPSF_PATH: ${{ needs.data.outputs.webbpsf_path }}
CRDS_PATH: ${{ needs.data.outputs.path }}/crds_cache
WEBBPSF_PATH: /tmp/data/webbpsf-data/
CRDS_PATH: /tmp/data/crds_cache/
CRDS_SERVER_URL: https://roman-crds.stsci.edu
CRDS_CLIENT_RETRY_COUNT: 3
CRDS_CLIENT_RETRY_DELAY_SECONDS: 20
cache-path: ${{ needs.data.outputs.path }}
cache-key: data-${{ needs.data.outputs.webbpsf_hash }}-${{ needs.crds_contexts.outputs.roman }}
cache-restore-keys: webbpsf-${{ needs.data.outputs.webbpsf_hash }}
cache-path: /tmp/data/
cache-key: data-${{ needs.webbpsf_data_cache.outputs.cache_key }}-${{ needs.crds_contexts.outputs.roman }}
cache-restore-keys: ${{ needs.webbpsf_data_cache.outputs.cache_key }}
envs: |
- linux: py310-stdevdeps-webbpsf
- linux: py310-devdeps-webbpsf
Expand Down

0 comments on commit 52a6ce9

Please sign in to comment.