chore: reflect the repo name change for packaging metadata #7
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 GuideUpdates repository metadata and CI/publishing workflows to reflect the repo rename from java-api-17 to java-api, streamlines CI by removing the pr-build indirection, and renames pre-commit hooks for clarity. 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:
- With the new
tox-packageandtox-stubsjobs gated ongithub.event_name == 'pull_request'and the removal ofworkflow_call/workflow_dispatch, CI for tox no longer runs onpushtomainor as a reusable workflow; confirm this reduced coverage is intentional or add corresponding conditions/triggers if you still want those paths exercised. - The
publish.ymlworkflow now uploads directly to PyPI without depending on the previousci/pr-buildworkflows, so if you still need artifacts built or validation performed before publishing, consider reintroducing those steps or explicitly building/verifying withinpypi-upload.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- With the new `tox-package` and `tox-stubs` jobs gated on `github.event_name == 'pull_request'` and the removal of `workflow_call`/`workflow_dispatch`, CI for tox no longer runs on `push` to `main` or as a reusable workflow; confirm this reduced coverage is intentional or add corresponding conditions/triggers if you still want those paths exercised.
- The `publish.yml` workflow now uploads directly to PyPI without depending on the previous `ci`/`pr-build` workflows, so if you still need artifacts built or validation performed before publishing, consider reintroducing those steps or explicitly building/verifying within `pypi-upload`.
## Individual Comments
### Comment 1
<location> `.github/workflows/publish.yml:9` </location>
<code_context>
- needs: ci
- uses: ./.github/workflows/pr-build.yml
-
pypi-upload:
- needs: pr-build
runs-on: ubuntu-latest
</code_context>
<issue_to_address>
**issue (bug_risk):** Removing the `needs` chain allows PyPI upload without any CI/pr-build gating.
`pypi-upload` will now run on every `release` event even if CI/pr-build fails. If you still want uploads blocked by tests/builds, please add an explicit dependency (e.g., on a check job or reusable workflow). If this decoupling is intentional, verify that nothing else still assumes the old gated behavior.
</issue_to_address>
### Comment 2
<location> `.github/workflows/ci.yml:10-12` </location>
<code_context>
- workflow_dispatch:
jobs:
+ tox-package:
+ if: ${{ github.event_name == 'pull_request' }}
+ uses: coatl-dev/workflows/.github/workflows/tox-docker.yml@v6
+
+ tox-stubs:
</code_context>
<issue_to_address>
**question (testing):** Tox jobs are restricted to pull requests and will not run on pushes to `main`.
Because `tox-package` (and `tox-stubs`) is guarded by `if: ${{ github.event_name == 'pull_request' }}`, these checks won’t run on `push` events to `main`—only `pylint` will. If you want tox to run on direct pushes (e.g., release or admin pushes), consider adjusting the condition to also allow `push` to `main` (e.g., via `github.ref == 'refs/heads/main'`). If tox-on-PR-only is intentional, no change needed.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| needs: ci | ||
| uses: ./.github/workflows/pr-build.yml | ||
|
|
||
| pypi-upload: |
Contributor
There was a problem hiding this comment.
issue (bug_risk): Removing the needs chain allows PyPI upload without any CI/pr-build gating.
pypi-upload will now run on every release event even if CI/pr-build fails. If you still want uploads blocked by tests/builds, please add an explicit dependency (e.g., on a check job or reusable workflow). If this decoupling is intentional, verify that nothing else still assumes the old gated behavior.
Comment on lines
+10
to
+12
| tox-package: | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| uses: coatl-dev/workflows/.github/workflows/tox-docker.yml@v6 |
Contributor
There was a problem hiding this comment.
question (testing): Tox jobs are restricted to pull requests and will not run on pushes to main.
Because tox-package (and tox-stubs) is guarded by if: ${{ github.event_name == 'pull_request' }}, these checks won’t run on push events to main—only pylint will. If you want tox to run on direct pushes (e.g., release or admin pushes), consider adjusting the condition to also allow push to main (e.g., via github.ref == 'refs/heads/main'). If tox-on-PR-only is intentional, no change needed.
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.
streamline ci
Summary by Sourcery
Update repository metadata and CI workflows to reflect the java-api repo rename and simplify packaging automation.
Enhancements:
CI:
Documentation: