Skip to content

chore: update failure conditions for docs workflow#3887

Merged
maxrjones merged 2 commits intozarr-developers:mainfrom
maxrjones:docs-trigger
Apr 9, 2026
Merged

chore: update failure conditions for docs workflow#3887
maxrjones merged 2 commits intozarr-developers:mainfrom
maxrjones:docs-trigger

Conversation

@maxrjones
Copy link
Copy Markdown
Member

We don't want PRs to show as failing CI due to this new docs job.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Apr 8, 2026
@maxrjones maxrjones requested a review from d-v-b April 8, 2026 20:00
@maxrjones maxrjones changed the title chore: update failures conditions for docs workflow chore: update failure conditions for docs workflow Apr 8, 2026
@d-v-b
Copy link
Copy Markdown
Contributor

d-v-b commented Apr 9, 2026

if the docs build is allowed to pass even when this check fails, then maybe this check should not be in the same workflow as the docs build?

@maxrjones
Copy link
Copy Markdown
Member Author

if the docs build is allowed to pass even when this check fails, then maybe this check should not be in the same workflow as the docs build?

I think eventually we would want the docs checking workflow to fail based on this test, once we clean up the state of our API so that the public functions only use public types. But for now, the noise is not worth it.

@maxrjones maxrjones merged commit 9681cf9 into zarr-developers:main Apr 9, 2026
30 checks passed
@maxrjones maxrjones deleted the docs-trigger branch April 9, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants