Fix docs to deploy only when a new release is published

[rads-1996]

No description provided.

[Copilot]

Pull request overview

This PR updates the GitHub Pages docs deployment workflow trigger to avoid rebuilding/deploying docs on every push to main, aiming to keep published docs aligned with the latest released package version.

Changes:

• Add a paths filter so the docs workflow runs on pushes to main only when src/microsoft/opentelemetry/_version.py changes.
• Add workflow comments explaining the intent of version-driven doc deployments.

Comments suppressed due to low confidence (2)

.github/workflows/docs.yml:9

• The path filter only watches src/microsoft/opentelemetry/_version.py, but the package version is also declared in pyproject.toml ([project].version). If a release/version bump updates only pyproject.toml (or the two get temporarily out of sync), this workflow will not deploy updated docs. Consider including pyproject.toml in on.push.paths (and any other authoritative version file) so docs deploy reliably when the released version changes.

  push:
    branches: [main]
    paths:
      - "src/microsoft/opentelemetry/_version.py"

.github/workflows/docs.yml:5

• The new comment says docs rebuild “only when the package version changes”, but the workflow will run on any change to _version.py (even non-version edits). Consider adjusting the wording to reflect the actual condition (file change) or constraining changes to that file to version bumps only.

  # Rebuild docs only when the package version changes on main, so the
  # published docs always match the latest released package version

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.