Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf(docs): Disable GH checks on docs that don't apply to docs #3206

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

J2-D2-3PO
Copy link
Contributor

@J2-D2-3PO J2-D2-3PO commented Dec 11, 2024

Description

https://wandb.atlassian.net/browse/DOCS-1108

Proposes disabling GH action checks that don't apply to things that live in the docs folder.

Reason:

  1. Save 💰 and resources
  2. Speed up docs deployment / PR process. As of now, every docs PR has to pass 100+ checks, most of which don't apply to the docs themselves
  3. Free up engineering from having to help docs team figure out some of the issues with tests randomly failing that don't apply anyways

Testing

  • Push changes to docs to test what happens on this branch
  • Need to confirm with the team that all changes are ok first. Assuming that we only need to keep the following tests for docs (but if we can disable more then cheers )
    • weave/.github/workflows/check-which-tests-to-run.yaml
    • weave/.github/workflows/cla.yaml
    • weave/.github/workflows/deploy.yaml
    • weave/.github/workflows/pr.yaml
    • weave/.github/workflows/release.yaml
    • trace-docs in weave/.github/workflows/test.yaml
      I added this to trace-docs to override the global docs disable on this test: if: ${{ github.event_name == 'push' && (github.event.before == 'docs/**' || github.event.commits | contains('docs')) }}. Alternatively, could break out into separate file, but need to check with team if this would cause other issues / more work

Help requested from @wandb/weave-team before proceeding further
#3206 (comment)

@J2-D2-3PO
Copy link
Contributor Author

J2-D2-3PO commented Dec 11, 2024

@wandb/weave-team could I get someone to look at this before I proceed any further?

For one, I'm not sure what's going on here.

image

@circle-job-mirror
Copy link

circle-job-mirror bot commented Dec 11, 2024

@J2-D2-3PO J2-D2-3PO self-assigned this Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant