Update book.yml

[Sweetdevil144]

Update GitHub Actions Workflow for Documentation Deployment

Priority: High
Status: Ready for Review
Type: Bugfix

I do not have permission to select labels. I would like the labels "bug", "documentation", and "CI/CD" to be added.

Description

This PR updates the book.yml GitHub Actions workflow to fix an issue with the deployment of our documentation. The previous version of the workflow incorrectly identified branches as tags, leading to a misconfigured deployment process. Changes include:

• Refining the if conditions to trigger deployments only on push events to master or develop branches, or when new tags are pushed.
• Modifying the export VERSION line to correctly handle GitHub references that include slashes, ensuring branches and tags are correctly identified for versioning the documentation.

Motivation and Context

The current workflow is causing unnecessary directories to be created in our documentation repository, leading to clutter and confusion. This change is required to streamline our CI/CD process and make sure that only the necessary directories are created and maintained.

This PR addresses the workflow misconfiguration discussed in issue #3152 .

---

Review Time Estimate

• [x] Immediately
• [ ] Within one week
• [ ] When possible

Types of changes

• [x] Bug fix (non-breaking change which fixes an issue) #3152
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• [ ] My change requires a change to the documentation.
• [ ] My name is in the list of CITATION.cff
• [ ] I have updated the CHANGELOG.md.
• [ ] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [x] All new and existing tests passed.

[Sweetdevil144]

PR breaks down the workflow. Test suites fail for the current workflow. I guess this was due to book.yml and would like to know how to proceed. I'm looking at the logs now. Would love ANY kind of help!!

[infotroph]

@Sweetdevil144 I don't think these CI failures are related to your changes -- we've been fighting intermittent failures that I think are related to an out-of-date build image. I'm debugging the CI issues on my end and will review your changes once I've worked those out. Sorry for the wait.

[Sweetdevil144]

Yeah sure. I can help you with that too if I can. Can you mention the workflows that are causing it?

[Sweetdevil144]

This is how the current changes look like :

    # ...
    # download documentation repo
    - name: Checkout documentation repo
      if: github.event_name == 'push'
      uses: actions/checkout@v3
      # ... rest of the step
    # upload new documentation
    - name: publish to github
      if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop')
      run: |
        # ... rest of the step

[Sweetdevil144]

Hey @infotroph, I found many redundancies n the documentation. Can I correct some of them via this PR?

[infotroph]

@Sweetdevil144 Better to make a separate PR so that we can get this one finished and merged, but yes to doing the corrections!