Skip to content

ci: add reusable docs-only change check#965

Merged
camilamaia merged 2 commits into
scanapi:mainfrom
nightt5879:nightt5879/reusable-docs-change-check
May 25, 2026
Merged

ci: add reusable docs-only change check#965
camilamaia merged 2 commits into
scanapi:mainfrom
nightt5879:nightt5879/reusable-docs-change-check

Conversation

@nightt5879
Copy link
Copy Markdown
Contributor

Closes #964

Summary

  • add a reusable local changed-files-check composite action for documentation-only change detection
  • use dorny/paths-filter inside the local action instead of maintaining custom shell/API detection logic
  • wire the reusable docs_only output into the examples and pytest/codecov workflows

Impact

Documentation-only pull requests can skip the external examples jobs and pytest matrix, while code changes and pushes to main continue to run the full workflows.

Validation

  • uv run python -c "import yaml, pathlib; [yaml.safe_load(path.open(encoding='utf-8')) for path in [pathlib.Path('.github/actions/changed-files-check/action.yml'), pathlib.Path('.github/workflows/run-examples.yml'), pathlib.Path('.github/workflows/pytest-and-codecov.yml')]]; print('yaml valid')" - passed
  • git diff --check - passed

@nightt5879 nightt5879 marked this pull request as ready for review May 25, 2026 13:20
@nightt5879 nightt5879 requested review from a team as code owners May 25, 2026 13:20
Comment thread .github/actions/changed-files-check/action.yml Outdated
Co-authored-by: Camila Maia <cmaiacd@gmail.com>
@camilamaia
Copy link
Copy Markdown
Member

@nightt5879 I’ll merge this PR first so we can test whether it works properly with the other one 🤞

@camilamaia camilamaia merged commit bc63303 into scanapi:main May 25, 2026
12 checks passed
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.

Create reusable change detection GitHub Action for CI optimization

2 participants