Skip to content

Conversation

@daquinteroflex
Copy link
Collaborator

@daquinteroflex daquinteroflex commented Dec 1, 2025

Greptile Overview

Greptile Summary

This PR introduces comprehensive Docker development environment improvements and adds integration testing for tidy3d-extras. The changes include expanding the Docker documentation from a minimal 88-line guide to a comprehensive 784-line reference, adding AWS CodeArtifact support to the development container, and establishing dedicated CI workflows for testing tidy3d-extras integration across multiple platforms and Python versions. The enhanced documentation provides step-by-step setup instructions, daily development workflows, VSCode integration, troubleshooting guides, and AWS CodeArtifact access for internal developers. The Docker container improvements add groff, mandoc, and the poetry-codeartifact-login plugin to support better documentation rendering and private package access. The new CI workflow ensures compatibility between the main tidy3d package and its extras components with automated testing across Windows, Ubuntu, and macOS platforms.

Important Files Changed

Filename Score Overview
docs/development/docker.rst 5/5 Significantly expanded Docker documentation from 88 to 784lines with comprehensive setup, workflows, and troubleshooting
dev.Dockerfile 5/5 Added groff/mandoc packages and poetry-codeartifact-login plugin to enhance development container capabilities
.github/workflows/tidy3d-extras-python-client-integration-tests.yml 5/5 New GitHub Actions workflow for testing tidy3d-extras integration across multiple Python versions and platforms
.github/workflows/tidy3d-python-client-tests.yml 5/5 Enhanced main test workflow to support new tidy3d-extras integration test category

Confidence score: 5/5

  • This PR is extremely safe to merge with minimal risk - it primarily enhances documentation and adds testing infrastructure without modifying core functionality
  • Score reflects that all changes are additive improvements (documentation expansion, new test workflows, container enhancements) with no modifications to core application logic or breaking changes
  • No files require special attention - all changes follow established patterns and best practices

Context used:

  • Rule from dashboard - Require a changelog entry for any PR that is not purely an internal refactor. (source)

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.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@daquinteroflex daquinteroflex changed the title docs: improve get-started docker docs: improve get-started docker (FXC-3911) Dec 1, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

Diff Coverage

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

No lines with coverage information in this diff.

@daquinteroflex daquinteroflex changed the title docs: improve get-started docker (FXC-3911) ci: tidy3d-extras integration tests and docs/dev setup (FXC-3911) Dec 2, 2025
@daquinteroflex daquinteroflex force-pushed the dario/codeartifact_docs branch 8 times, most recently from 9921fa1 to a9e8197 Compare December 2, 2025 20:49
@daquinteroflex daquinteroflex force-pushed the dario/codeartifact_docs branch 2 times, most recently from 37fca68 to 351ef04 Compare December 4, 2025 19:46
@daquinteroflex daquinteroflex force-pushed the dario/codeartifact_docs branch from 351ef04 to 75a0f53 Compare December 4, 2025 20:20
Copy link
Contributor

@caseyflex caseyflex left a comment

Choose a reason for hiding this comment

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

Nice! The docker documentation seems helpful and good to have integration tests. A few comments

@daquinteroflex
Copy link
Collaborator Author

@greptile re review

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.

4 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@daquinteroflex daquinteroflex force-pushed the dario/codeartifact_docs branch 5 times, most recently from 2645fdd to 74a2b41 Compare December 5, 2025 09:46
@daquinteroflex
Copy link
Collaborator Author

daquinteroflex commented Dec 5, 2025

@caseyflex I've implemented your suggestions and moved the license_test_ci.py to this repo. I'm getting some weird multiplatform errors ( ubuntu and windows are fine, mac are not, maybe it's some issues on tidy3d extras we haven't caught yet? https://github.com/flexcompute/tidy3d/actions/runs/19959108730/job/57234958887

I'll have time to work on this later today but need to do some other stuff for now, just thought to let you know in case it's clearer to you what's going on

@daquinteroflex daquinteroflex force-pushed the dario/codeartifact_docs branch from 74a2b41 to ddeb514 Compare December 5, 2025 10:51
@caseyflex
Copy link
Contributor

@daquinteroflex is it still broken on those platforms?

@daquinteroflex
Copy link
Collaborator Author

daquinteroflex commented Dec 5, 2025

Yeah haven't been able to get back to it, find it weird it works for ubuntu but not mac if its the same action config? Looks like an issue with the extension?

@daquinteroflex daquinteroflex changed the title ci: tidy3d-extras integration tests and docs/dev setup (FXC-3911) ci: tidy3d-extras integration tests and docs/dev setup (FXC-4441) Dec 5, 2025
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.

3 participants