Skip to content

Conversation

daquinteroflex
Copy link
Collaborator

@daquinteroflex daquinteroflex commented Aug 4, 2025

Greptile Summary

This PR enhances the GitHub Actions workflow that synchronizes documentation from the main repository to a Read the Docs mirror repository. The changes add manual workflow dispatch capability, allowing developers to manually trigger documentation syncs and optionally specify a target branch different from the source branch. This provides more flexibility for documentation deployment strategies, testing changes on different branches, and preparing releases.

The workflow maintains backward compatibility - when triggered automatically (via push/tag events), it continues to mirror content to the same branch/tag names as before. However, when manually triggered, users can now specify a target branch parameter to push content from any source branch to a specific target branch in the mirror repository.

Additionally, the PR includes maintenance updates to keep the workflow compatible with current GitHub Actions standards: upgrading from deprecated set-output syntax to GITHUB_OUTPUT environment files, and updating checkout actions from v3 to v4. The logic for pushing to the mirror repository has been consolidated and made conditional based on the trigger type.

The submodule update for docs/notebooks brings in newer notebook content that will be included in the synchronized documentation.

Important Files Changed

File Changes
Filename Score Overview
.github/workflows/tidy3d-docs-sync-readthedocs-repo.yml 4/5 Added manual workflow dispatch with target branch parameter and updated GitHub Actions syntax
docs/notebooks 5/5 Updated submodule reference to bring in newer notebook content

Confidence score: 4/5

  • This PR is safe to merge with minimal risk as it primarily adds optional functionality and performs maintenance updates
  • Score reflects well-structured workflow enhancements with proper conditional logic and backward compatibility preservation
  • Pay close attention to the workflow file to ensure the conditional branching logic works correctly in both manual and automatic trigger scenarios

@daquinteroflex daquinteroflex force-pushed the dario/sync_manual_docs branch from 7571a6e to 9579d07 Compare August 4, 2025 12:33
@daquinteroflex daquinteroflex marked this pull request as ready for review August 4, 2025 12:33
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

@daquinteroflex daquinteroflex force-pushed the dario/sync_manual_docs branch from 9579d07 to fda80e9 Compare August 4, 2025 12:37
@daquinteroflex
Copy link
Collaborator Author

@daquinteroflex daquinteroflex merged commit c6be584 into develop Aug 4, 2025
11 checks passed
@daquinteroflex daquinteroflex deleted the dario/sync_manual_docs branch August 4, 2025 12:51
Copy link
Contributor

github-actions bot commented Aug 4, 2025

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

No lines with coverage information in this diff.

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