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

ci: fix automatic docs gen #1807

Merged
merged 1 commit into from
Mar 6, 2025
Merged

ci: fix automatic docs gen #1807

merged 1 commit into from
Mar 6, 2025

Conversation

collindutter
Copy link
Member

@collindutter collindutter commented Mar 4, 2025

Describe your changes

Problem

  1. The documentation log script only runs on changed *.py files in the docs/ directory. If integration tests fail for some reason, the next PR that fixes the integration tests will not contain the originally changed *.py files. Therefore logs are not generated for those files.
  2. There is no way to regenerate logs without changing the associated *.py file.

Solution

Run on all *.py files. For each one that has logs:

  • If it needs conversion ( example of what I mean by "conversion"), convert it and copy the logs.
  • If it doesn't need conversion, but it is a changed file, just copy the logs.

If a developer needs to regenerate logs without changing a .py file, they can "unconvert" the example and it will be converted on the next run.

Functioning PR here.

Issue ticket number and link

NA

@collindutter collindutter force-pushed the fix/docs-gen branch 11 times, most recently from 6081861 to 06609ed Compare March 5, 2025 01:01
@collindutter collindutter requested a review from a team March 5, 2025 01:01
@collindutter collindutter self-assigned this Mar 5, 2025
@collindutter collindutter marked this pull request as ready for review March 5, 2025 01:01
@collindutter collindutter added the docs Related to documentation. label Mar 5, 2025
@collindutter collindutter added this to the 1.5 milestone Mar 5, 2025
@collindutter collindutter added the github_actions Pull requests that update GitHub Actions code label Mar 5, 2025
@collindutter collindutter enabled auto-merge March 5, 2025 16:52
Copy link
Member

@vachillo vachillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good :drivingcrooner:

@collindutter collindutter added this pull request to the merge queue Mar 6, 2025
Merged via the queue into main with commit 745f1db Mar 6, 2025
15 checks passed
@collindutter collindutter deleted the fix/docs-gen branch March 6, 2025 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation. github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants