Address PyOpenSci comments #15
Workflow file for this run
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 Notebooks | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| build-notebooks: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout stingray repo | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: StingraySoftware/stingray | |
| path: ./stingray | |
| submodules: recursive | |
| # This step gets the latest commit of the PR or the pushed commit and checks out the PR version of the notebooks | |
| - name: Get latest commit of the PR or pushed commit and Checkout PR version of Notebooks | |
| run: | | |
| # If the event is a pull request, fetch the PR SHA | |
| if [ "${{ github.event_name }}" == "pull_request" ]; then | |
| echo "PR event detected. Fetching PR SHA..." | |
| PR_SHA=$(curl -s 'https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}' | jq -r .head.sha) | |
| if [ "$PR_SHA" == "null" ]; then | |
| echo "::error::Failed to get PR SHA" | |
| exit 1 | |
| fi | |
| echo "commit=$PR_SHA" >> $GITHUB_ENV | |
| cd ./stingray/docs/notebooks # Change to the submodule directory | |
| git fetch origin $PR_SHA:pr_temp | |
| git checkout pr_temp | |
| # If the event is a push, use the pushed commit SHA | |
| else | |
| echo "Push event detected. Using pushed commit SHA..." | |
| echo "commit=${{ github.sha }}" >> $GITHUB_ENV | |
| cd ./stingray/docs/notebooks # Change to the submodule directory | |
| pwd | |
| git fetch origin ${{ github.sha }}:pr_temp | |
| git checkout pr_temp | |
| fi | |
| # This step verifies that the submodule has been updated | |
| - name: Verify submodule update | |
| run: | | |
| cd ./stingray/docs/notebooks | |
| git log -1 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Install pandoc and additional dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y pandoc fonts-freefont-ttf | |
| pip install sphinx sphinx-astropy tox | |
| - name: Install Stingray | |
| run: | | |
| pip install -e ./stingray | |
| - name: Run Build Docs | |
| run: | | |
| cd ./stingray | |
| tox -e build_docs |