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

fix(type-safe-api): add empty README.md for generated python projects #818

Merged
merged 1 commit into from
Aug 6, 2024

Conversation

jstrunk
Copy link
Contributor

@jstrunk jstrunk commented Aug 1, 2024

The poetry install that runs as part of post synthesis expects there to be some code present, but code isn't generated until build time. This means that the first install will fail when either generating the project for the first time or checking out a fresh copy (since generated code is not checked in to version control).

To fix this, we add a blank README.md file in addition to the init.py file as the first install step to keep poetry happy until the generator overwrites it.

Fixes #813

…ted python projects

The poetry install that runs as part of post synthesis expects there to be some
code present, but code isn't generated until build time. This means that the
first install will fail when either generating the project for the first time or
checking out a fresh copy (since generated code is not checked in to version
control).

To fix this, we add a blank README.md file in addition to the __init__.py file
as the first install step to keep poetry happy until the generator overwrites
it.

Fixes aws#813
Copy link

nx-cloud bot commented Aug 1, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5219a86. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jstrunk
Copy link
Contributor Author

jstrunk commented Aug 5, 2024 via email

@jstrunk
Copy link
Contributor Author

jstrunk commented Aug 5, 2024

% pwd
packages/api/generated/runtime/python
% ls -R
README.md				poetry.lock
api_detective_api_python_runtime	poetry.toml
dist					project.json
docs					pyproject.toml
openapitools.json

./api_detective_api_python_runtime:
__init__.py
...

@agdimech agdimech merged commit 9f5d63c into aws:mainline Aug 6, 2024
4 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.

[BUG] (type-safe-api) install fails on python runtime package with missing README
2 participants