ci: testpypi and aws deploy / test #2967
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,328 @@ | ||||||
| name: "public/tidy3d/python-client-deploy" | ||||||
|
|
||||||
| on: | ||||||
| workflow_dispatch: | ||||||
| inputs: | ||||||
| release_tag: | ||||||
| description: 'Release tag to deploy (e.g., v2.10.0, v2.10.0rc1)' | ||||||
| required: true | ||||||
| type: string | ||||||
|
|
||||||
| deploy_testpypi: | ||||||
| description: 'Deploy to TestPyPI (recommended first step)' | ||||||
| type: boolean | ||||||
| default: false | ||||||
|
|
||||||
| deploy_pypi: | ||||||
| description: 'Deploy to production PyPI' | ||||||
| type: boolean | ||||||
| default: false | ||||||
|
|
||||||
| deploy_aws: | ||||||
| description: 'Deploy to AWS CodeArtifact' | ||||||
| type: boolean | ||||||
| default: false | ||||||
|
|
||||||
| workflow_call: | ||||||
| inputs: | ||||||
| release_tag: | ||||||
| description: 'Release tag to deploy' | ||||||
| required: true | ||||||
| type: string | ||||||
| deploy_testpypi: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| deploy_pypi: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| deploy_aws: | ||||||
| type: boolean | ||||||
| default: false | ||||||
|
|
||||||
| permissions: | ||||||
| contents: read | ||||||
|
|
||||||
| env: | ||||||
| AWS_REGION: "us-east-1" | ||||||
|
|
||||||
| jobs: | ||||||
| validate-inputs: | ||||||
| name: validate-deployment-inputs | ||||||
| runs-on: ubuntu-latest | ||||||
| outputs: | ||||||
| release_tag: ${{ env.RELEASE_TAG }} | ||||||
| deploy_testpypi: ${{ env.DEPLOY_TESTPYPI }} | ||||||
| deploy_pypi: ${{ env.DEPLOY_PYPI }} | ||||||
| deploy_aws: ${{ env.DEPLOY_AWS }} | ||||||
| env: | ||||||
| RELEASE_TAG: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.release_tag || inputs.release_tag }} | ||||||
| DEPLOY_TESTPYPI: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_testpypi || inputs.deploy_testpypi }} | ||||||
| DEPLOY_PYPI: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_pypi || inputs.deploy_pypi }} | ||||||
| DEPLOY_AWS: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_aws || inputs.deploy_aws }} | ||||||
| steps: | ||||||
| - name: validate-inputs | ||||||
| run: | | ||||||
| set -e | ||||||
| echo "=== Deployment Configuration ===" | ||||||
| echo "Release tag: $RELEASE_TAG" | ||||||
| echo "Deploy to TestPyPI: $DEPLOY_TESTPYPI" | ||||||
| echo "Deploy to PyPI: $DEPLOY_PYPI" | ||||||
| echo "Deploy to AWS CodeArtifact: $DEPLOY_AWS" | ||||||
| echo "" | ||||||
|
|
||||||
| # Validate at least one target is selected | ||||||
| if [[ "$DEPLOY_TESTPYPI" != "true" && "$DEPLOY_PYPI" != "true" && "$DEPLOY_AWS" != "true" ]]; then | ||||||
| echo "Error: At least one deployment target must be selected" | ||||||
| exit 1 | ||||||
| fi | ||||||
|
|
||||||
| # Validate tag format | ||||||
| TAG_REGEX='^v[0-9]+\.[0-9]+\.[0-9]+(rc[0-9]+)?$' | ||||||
| if [[ ! "$RELEASE_TAG" =~ $TAG_REGEX ]]; then | ||||||
| echo " Warning: Tag format doesn't match standard pattern v{major}.{minor}.{patch}[rc{num}]" | ||||||
| echo " Tag: $RELEASE_TAG" | ||||||
| echo " Continuing anyway..." | ||||||
| fi | ||||||
|
|
||||||
| echo "Validation passed" | ||||||
|
|
||||||
| build-package: | ||||||
| name: build-distribution-package | ||||||
| needs: validate-inputs | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - name: checkout-tag | ||||||
| uses: actions/checkout@v4 | ||||||
| with: | ||||||
| ref: ${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| persist-credentials: false | ||||||
|
|
||||||
| - name: setup-python | ||||||
| uses: actions/setup-python@v5 | ||||||
| with: | ||||||
| python-version: '3.10' | ||||||
|
|
||||||
| - name: install-poetry | ||||||
| run: | | ||||||
| python -m pip install --upgrade pip | ||||||
| python -m pip install poetry | ||||||
|
|
||||||
| - name: build-package | ||||||
| env: | ||||||
| RELEASE_TAG: ${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| run: | | ||||||
| echo "Building package from tag ${RELEASE_TAG}..." | ||||||
| poetry build | ||||||
| echo "" | ||||||
| echo "Build artifacts:" | ||||||
| ls -lh dist/ | ||||||
| echo "" | ||||||
| echo "Package built successfully" | ||||||
|
|
||||||
| - name: upload-artifacts | ||||||
| uses: actions/upload-artifact@v4 | ||||||
| with: | ||||||
| name: dist-${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| path: dist/ | ||||||
| retention-days: 7 | ||||||
|
|
||||||
| deploy-testpypi: | ||||||
| name: deploy-to-testpypi | ||||||
| needs: [validate-inputs, build-package] | ||||||
| if: needs.validate-inputs.outputs.deploy_testpypi == 'true' | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - name: download-artifacts | ||||||
| uses: actions/download-artifact@v4 | ||||||
| with: | ||||||
| name: dist-${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| path: dist/ | ||||||
|
|
||||||
| - name: setup-python | ||||||
| uses: actions/setup-python@v5 | ||||||
| with: | ||||||
| python-version: '3.10' | ||||||
|
|
||||||
| - name: install-twine | ||||||
| run: | | ||||||
| python -m pip install --upgrade pip | ||||||
| python -m pip install twine | ||||||
|
|
||||||
| - name: publish-to-testpypi | ||||||
| env: | ||||||
| TWINE_USERNAME: __token__ | ||||||
| TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }} | ||||||
| run: | | ||||||
| echo "Publishing to TestPyPI..." | ||||||
| # zizmor: ignore[use-trusted-publishing] | ||||||
| python -m twine upload \ | ||||||
| --repository-url https://test.pypi.org/legacy/ \ | ||||||
| --verbose \ | ||||||
| dist/* | ||||||
| echo "" | ||||||
| echo "Successfully published to TestPyPI" | ||||||
| echo "View at: https://test.pypi.org/project/tidy3d/" | ||||||
|
|
||||||
| deploy-pypi: | ||||||
| name: deploy-to-pypi | ||||||
| needs: [validate-inputs, build-package, deploy-testpypi] | ||||||
| # Run after TestPyPI succeeds (or is skipped if not selected) | ||||||
| if: | | ||||||
| always() && | ||||||
| needs.validate-inputs.outputs.deploy_pypi == 'true' && | ||||||
| needs.build-package.result == 'success' && | ||||||
| (needs.deploy-testpypi.result == 'success' || needs.deploy-testpypi.result == 'skipped') | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - run: echo "hi" | ||||||
|
There was a problem hiding this comment. logic: production PyPI deployment commented out but job still runs Remove placeholder or implement proper deployment Prompt To Fix With AIThis is a comment left during a code review.
Path: .github/workflows/tidy3d-python-client-deploy.yml
Line: 177:177
Comment:
**logic:** production PyPI deployment commented out but job still runs
Remove placeholder or implement proper deployment
How can I resolve this? If you propose a fix, please make it concise. |
||||||
| # - name: download-artifacts | ||||||
| # uses: actions/download-artifact@v4 | ||||||
| # with: | ||||||
| # name: dist-${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| # path: dist/ | ||||||
|
|
||||||
| # - name: setup-python | ||||||
| # uses: actions/setup-python@v5 | ||||||
| # with: | ||||||
| # python-version: '3.10' | ||||||
|
|
||||||
| # - name: install-twine | ||||||
| # run: | | ||||||
| # python -m pip install --upgrade pip | ||||||
| # python -m pip install twine | ||||||
|
|
||||||
| # - name: publish-to-pypi | ||||||
| # env: | ||||||
| # TWINE_USERNAME: __token__ | ||||||
| # TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }} | ||||||
| # run: | | ||||||
| # echo "Publishing to production PyPI..." | ||||||
| # python -m twine upload \ | ||||||
| # --repository pypi \ | ||||||
| # --verbose \ | ||||||
| # dist/* | ||||||
| # echo "" | ||||||
| # echo "Successfully published to PyPI" | ||||||
| # echo " View at: https://pypi.org/project/tidy3d/" | ||||||
|
|
||||||
| deploy-aws-codeartifact: | ||||||
| name: deploy-to-aws-codeartifact | ||||||
| needs: [validate-inputs, build-package] | ||||||
| if: | | ||||||
| always() && | ||||||
| needs.validate-inputs.outputs.deploy_aws == 'true' && | ||||||
| needs.build-package.result == 'success' | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - name: download-artifacts | ||||||
| uses: actions/download-artifact@v4 | ||||||
| with: | ||||||
| name: dist-${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| path: dist/ | ||||||
|
|
||||||
| - name: setup-python | ||||||
| uses: actions/setup-python@v5 | ||||||
| with: | ||||||
| python-version: '3.10' | ||||||
|
|
||||||
| - name: install-twine | ||||||
| run: | | ||||||
| python -m pip install --upgrade pip | ||||||
| python -m pip install twine | ||||||
|
|
||||||
| - name: configure-aws-credentials | ||||||
| uses: aws-actions/configure-aws-credentials@v4 | ||||||
| with: | ||||||
| aws-region: ${{ env.AWS_REGION }} | ||||||
| aws-access-key-id: ${{ secrets.AWS_CODEARTIFACT_ACCESS_KEY }} | ||||||
| aws-secret-access-key: ${{ secrets.AWS_CODEARTIFACT_ACCESS_SECRET }} | ||||||
|
|
||||||
| - name: configure-codeartifact-package | ||||||
| run: | | ||||||
| echo "Configuring CodeArtifact package settings..." | ||||||
| aws codeartifact put-package-origin-configuration \ | ||||||
| --domain flexcompute \ | ||||||
| --repository pypi-releases \ | ||||||
| --format pypi \ | ||||||
| --package tidy3d \ | ||||||
| --restrictions '{"publish":"ALLOW", "upstream":"BLOCK"}' | ||||||
|
|
||||||
| - name: get-codeartifact-token | ||||||
| run: | | ||||||
| echo "Getting CodeArtifact authorization token..." | ||||||
| CODEARTIFACT_AUTH_TOKEN=$(aws codeartifact get-authorization-token \ | ||||||
| --domain flexcompute \ | ||||||
| --domain-owner 625554095313 \ | ||||||
| --region us-east-1 \ | ||||||
| --query authorizationToken \ | ||||||
| --output text) | ||||||
| echo "CODEARTIFACT_AUTH_TOKEN=${CODEARTIFACT_AUTH_TOKEN}" >> $GITHUB_ENV | ||||||
|
|
||||||
|
|
||||||
| - name: publish-to-codeartifact | ||||||
| env: | ||||||
| TWINE_PASSWORD: ${{ env.CODEARTIFACT_AUTH_TOKEN }} | ||||||
|
There was a problem hiding this comment. logic:
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: .github/workflows/tidy3d-python-client-deploy.yml
Line: 264:264
Comment:
**logic:** `CODEARTIFACT_AUTH_TOKEN` not available in this env context
```suggestion
TWINE_PASSWORD: ${{ env.CODEARTIFACT_AUTH_TOKEN }}
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||
| run: | | ||||||
| echo "Publishing to AWS CodeArtifact..." | ||||||
| # zizmor: ignore[use-trusted-publishing] | ||||||
| python -m twine upload \ | ||||||
| --repository-url https://flexcompute-625554095313.d.codeartifact.us-east-1.amazonaws.com/pypi/pypi-releases/ \ | ||||||
| --verbose \ | ||||||
| -u aws \ | ||||||
| -p "$TWINE_PASSWORD" \ | ||||||
| dist/* | ||||||
| echo "" | ||||||
| echo "Successfully published to AWS CodeArtifact" | ||||||
|
|
||||||
| deployment-summary: | ||||||
| name: deployment-summary | ||||||
| needs: [validate-inputs, build-package, deploy-testpypi, deploy-pypi, deploy-aws-codeartifact] | ||||||
| if: always() | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - name: generate-summary | ||||||
| env: | ||||||
| RELEASE_TAG: ${{ needs.validate-inputs.outputs.release_tag }} | ||||||
| BUILD_RESULT: ${{ needs.build-package.result }} | ||||||
| TESTPYPI_RESULT: ${{ needs.deploy-testpypi.result }} | ||||||
| PYPI_RESULT: ${{ needs.deploy-pypi.result }} | ||||||
| AWS_RESULT: ${{ needs.deploy-aws-codeartifact.result }} | ||||||
| DEPLOY_TESTPYPI: ${{ needs.validate-inputs.outputs.deploy_testpypi }} | ||||||
| DEPLOY_PYPI: ${{ needs.validate-inputs.outputs.deploy_pypi }} | ||||||
| DEPLOY_AWS: ${{ needs.validate-inputs.outputs.deploy_aws }} | ||||||
| run: | | ||||||
| echo "=== Deployment Summary ===" | ||||||
| echo "Release Tag: ${RELEASE_TAG}" | ||||||
| echo "" | ||||||
| echo "Build Package: ${BUILD_RESULT}" | ||||||
| echo "TestPyPI: ${TESTPYPI_RESULT}" | ||||||
| echo "PyPI: ${PYPI_RESULT}" | ||||||
| echo "AWS CodeArtifact: ${AWS_RESULT}" | ||||||
| echo "" | ||||||
|
|
||||||
| # Check for failures | ||||||
| if [[ "${BUILD_RESULT}" == "failure" ]]; then | ||||||
| echo "Build failed" | ||||||
| exit 1 | ||||||
| fi | ||||||
|
|
||||||
| # Check if any selected deployment failed | ||||||
| failed=false | ||||||
| if [[ "${DEPLOY_TESTPYPI}" == "true" && "${TESTPYPI_RESULT}" == "failure" ]]; then | ||||||
| echo "TestPyPI deployment failed" | ||||||
| failed=true | ||||||
| fi | ||||||
| if [[ "${DEPLOY_PYPI}" == "true" && "${PYPI_RESULT}" == "failure" ]]; then | ||||||
| echo "PyPI deployment failed" | ||||||
| failed=true | ||||||
| fi | ||||||
| if [[ "${DEPLOY_AWS}" == "true" && "${AWS_RESULT}" == "failure" ]]; then | ||||||
| echo "AWS CodeArtifact deployment failed" | ||||||
| failed=true | ||||||
| fi | ||||||
|
|
||||||
| if [[ "$failed" == "true" ]]; then | ||||||
| exit 1 | ||||||
| fi | ||||||
|
|
||||||
| echo "All selected deployments completed successfully" | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: all deployment targets default to
false, requiring manual selection each timeConsider defaulting
deploy_testpypitotruefor safer testing workflowPrompt To Fix With AI