build(pip): publish java-api and java-api-stubs to PyPI #5
Conversation
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
Contributor
Reviewer's GuideAdds automated PyPI publishing for the java-api and java-api-stubs packages upon GitHub releases, and updates the READMEs to point to the new PyPI distributions instead of direct GitHub installs and to reflect current environment details. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- In the publish workflow, the step names still say "Upload ignition-api" while the working directories are
java-apiandjava-api-stubs; consider renaming these to match the actual package names to avoid confusion. - For the
pypi-uploadjob, you explicitly pinpython-version: '3.12'only for thejava-api-stubsupload; consider either documenting or aligning the Python version for both uploads to keep the workflow behavior consistent and predictable.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the publish workflow, the step names still say "Upload ignition-api" while the working directories are `java-api` and `java-api-stubs`; consider renaming these to match the actual package names to avoid confusion.
- For the `pypi-upload` job, you explicitly pin `python-version: '3.12'` only for the `java-api-stubs` upload; consider either documenting or aligning the Python version for both uploads to keep the workflow behavior consistent and predictable.
## Individual Comments
### Comment 1
<location> `.github/workflows/publish.yml:20-21` </location>
<code_context>
+ needs: pr-build
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v6
+
+ - name: Upload ignition-api to PyPI
</code_context>
<issue_to_address>
**🚨 issue (security):** Pin `actions/checkout` to a stable major or SHA instead of `v6`.
`v6` doesn’t exist yet, and major tags can change with breaking updates. Please pin to the current stable major (e.g. `actions/checkout@v4`) or, preferably, to a specific commit SHA to avoid unexpected workflow breakage or behavior changes.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+20
to
+21
| - name: Checkout repo | ||
| uses: actions/checkout@v6 |
Contributor
There was a problem hiding this comment.
🚨 issue (security): Pin actions/checkout to a stable major or SHA instead of v6.
v6 doesn’t exist yet, and major tags can change with breaking updates. Please pin to the current stable major (e.g. actions/checkout@v4) or, preferably, to a specific commit SHA to avoid unexpected workflow breakage or behavior changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary by Sourcery
Publish the java-api and java-api-stubs packages to PyPI on release and update installation instructions accordingly.
CI:
Deployment:
Documentation: