fix preview docs failing due to running out of disk

[winglian]

Summary by CodeRabbit

• Chores
  • Optimized CI/CD pipeline performance by cleaning up system resources during documentation builds.
  • Enhanced workflow trigger configuration to rebuild when workflow definitions are modified.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Two GitHub Actions workflows receive updates to add a cleanup step that removes system/tooling directories before the checkout step, reducing build environment overhead. The preview-docs.yml workflow also adds itself to its trigger paths.

Changes

Cohort / File(s)	Summary
GitHub Actions workflow cleanup steps .github/workflows/docs.yml, .github/workflows/preview-docs.yml	Added a "cleanup node" step that removes /usr/share/dotnet, /usr/local/lib/android, /opt/ghc, /opt/hostedtoolcache/CodeQL before checkout to reduce disk usage.
Preview docs workflow triggers .github/workflows/preview-docs.yml	Added the workflow file itself (.github/workflows/preview-docs.yml) to the path filter, causing the workflow to run when this file changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• These are straightforward configuration additions with simple, repetitive patterns (identical cleanup steps in both workflows)
• Changes are localized to workflow trigger logic and shell commands with no complex conditional logic

Suggested reviewers

• djsaunde
• NanoCode012

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix preview docs failing due to running out of disk' directly addresses the main objective of the changeset. Both workflow files add disk cleanup steps to resolve disk space issues in CI/CD pipelines, which aligns precisely with the title's intent.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-preview-ci

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bbd3486 and f35caa7.

📒 Files selected for processing (2)

• .github/workflows/docs.yml (1 hunks)
• .github/workflows/preview-docs.yml (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: SalmanMohammadi
Repo: axolotl-ai-cloud/axolotl PR: 2994
File: index.qmd:7-8
Timestamp: 2025-07-31T11:48:46.313Z
Learning: In documentation workflow testing PRs, temporary test content like "test test" may be intentionally added to trigger documentation preview actions and validate workflow fixes, rather than being accidental debug text.

📚 Learning: 2025-07-31T11:48:46.313Z

Learnt from: SalmanMohammadi
Repo: axolotl-ai-cloud/axolotl PR: 2994
File: index.qmd:7-8
Timestamp: 2025-07-31T11:48:46.313Z
Learning: In documentation workflow testing PRs, temporary test content like "test test" may be intentionally added to trigger documentation preview actions and validate workflow fixes, rather than being accidental debug text.

Applied to files:

• .github/workflows/preview-docs.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

• GitHub Check: PyTest from Source Dist (3.11, 2.8.0)
• GitHub Check: PyTest (3.11, 2.9.0)
• GitHub Check: PyTest (3.11, 2.7.1)
• GitHub Check: PyTest from Source Dist (3.11, 2.9.0)
• GitHub Check: PyTest (3.11, 2.8.0)
• GitHub Check: PyTest from Source Dist (3.11, 2.7.1)
• GitHub Check: preview

🔇 Additional comments (3)

.github/workflows/preview-docs.yml (2)

14-14: LGTM! Self-trigger enables workflow testing.

Adding the workflow file itself to the trigger paths allows you to test changes to the workflow in PRs before merging. This is a best practice for workflow development.

---

31-34: LGTM! Cleanup step addresses disk space issue.

The cleanup step removes large, unused tool caches before checkout, which should effectively address the disk space issue mentioned in the PR title. The directories removed (dotnet, android, ghc, CodeQL) are well-known space consumers on GitHub-hosted runners and are appropriate targets for cleanup when building documentation.

.github/workflows/docs.yml (1)

15-17: LGTM! Consistent cleanup approach across workflows.

The cleanup step mirrors the implementation in preview-docs.yml, ensuring consistent disk management across both documentation workflows. This proactive cleanup on the main branch workflow prevents potential future disk space issues.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

📖 Documentation Preview: https://69457bb7272b20ac673dd3ed--resonant-treacle-0fd729.netlify.app

Deployed on Netlify from commit f35caa7

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!