tidy3d-submodule-PR-tests #3
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: "tidy3d-submodule-PR-tests" | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [ latest ] | |
| pull_request: | |
| branches: | |
| - latest | |
| jobs: | |
| test-latest-submodules: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository with submodules | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: 'recursive' | |
| # This fetches only a single branch by default, so additional fetch is needed | |
| fetch-depth: 0 # Optionally, set to 0 to fetch all history for all branches and tags | |
| - name: Determine current branch or PR ref | |
| id: get_branch | |
| run: | | |
| if [[ "${{ github.event_name }}" == "pull_request" ]]; then | |
| # Extract the base branch of the PR | |
| BRANCH_NAME="${{ github.event.pull_request.base.ref }}" | |
| echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV | |
| else | |
| # Assume it's a push event, extract the branch name from $GITHUB_REF | |
| BRANCH_NAME=$(echo $GITHUB_REF | sed 's|refs/heads/||') | |
| echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV | |
| fi | |
| # Now echoing the BRANCH_NAME to verify | |
| echo "BRANCH_NAME: $BRANCH_NAME" | |
| shell: bash | |
| env: | |
| GITHUB_REF: ${{ github.ref }} | |
| - name: Initialize and update submodule | |
| run: | | |
| git submodule update --init --recursive | |
| - name: Check if submodules are up to date | |
| shell: bash | |
| run: | | |
| NOTEBOOKS_PATH=docs/notebooks | |
| FAQ_PATH=docs/faq | |
| # Checking out Notebooks submodule with the same branch as the main project | |
| echo "Checking $NOTEBOOKS_PATH for updates..." | |
| cd $NOTEBOOKS_PATH | |
| NOTEBOOKS_CURRENT_COMMIT=$(git rev-parse HEAD) | |
| echo $(git fetch --all --verbose) | |
| echo $(git remote get-url origin) | |
| if git show-ref --verify refs/remotes/origin/$BRANCH_NAME; then | |
| echo "Branch $BRANCH_NAME exists." | |
| else | |
| echo "::error::Branch $BRANCH_NAME does not exist on remote." | |
| exit 1 | |
| fi | |
| NOTEBOOKS_LATEST_COMMIT=$(git rev-parse refs/remotes/origin/${{ env.BRANCH_NAME }}) | |
| echo "NOTEBOOKS_LATEST_COMMIT: $NOTEBOOKS_LATEST_COMMIT" | |
| echo "NOTEBOOKS_CURRENT_COMMIT: $NOTEBOOKS_CURRENT_COMMIT" | |
| cd ../.. | |
| if [ "$NOTEBOOKS_LATEST_COMMIT" != "$NOTEBOOKS_CURRENT_COMMIT" ]; then | |
| echo "::error ::Submodule $NOTEBOOKS_PATH is not up to date with the ${{ env.BRANCH_NAME }} branch. Please update it." | |
| exit 1 | |
| else | |
| echo "Submodule $NOTEBOOKS_PATH is up to date with the ${{ env.BRANCH_NAME }} branch." | |
| fi | |
| # Checking FAQs only on the develop branch. | |
| echo "Checking $FAQ_PATH for updates..." | |
| cd $FAQ_PATH | |
| FAQ_CURRENT_COMMIT=$(git rev-parse HEAD) | |
| echo $(git fetch --all --verbose) | |
| echo $(git remote get-url origin) | |
| FAQ_LATEST_COMMIT=$(git rev-parse refs/remotes/origin/develop) | |
| echo "FAQ_LATEST_COMMIT: $FAQ_LATEST_COMMIT" | |
| echo "FAQ_CURRENT_COMMIT: $FAQ_CURRENT_COMMIT" | |
| cd ../.. | |
| if [ "$FAQ_LATEST_COMMIT" != "$FAQ_CURRENT_COMMIT" ]; then | |
| echo "::error ::Submodule $FAQ_PATH is not up to date. Please update it." | |
| exit 1 | |
| else | |
| echo "Submodule $FAQ_PATH is up to date." | |
| fi |