Skip to content

build(pip): publish java-api and java-api-stubs to PyPI #5

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.

Sign up for GitHub

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

Merged
cesarcoatl merged 1 commit into from
Dec 8, 2025
Merged

build(pip): publish java-api and java-api-stubs to PyPI #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: publish

on:
release:
types:
- published

jobs:
ci:
uses: ./.github/workflows/ci.yml

pr-build:
needs: ci
uses: ./.github/workflows/pr-build.yml

pypi-upload:
needs: pr-build
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v6
Comment on lines +20 to +21
Copy link
Contributor

@sourcery-ai sourcery-ai bot Dec 8, 2025

Choose a reason for hiding this comment

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

🚨 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.


- name: Upload ignition-api to PyPI
uses: coatl-dev/actions/pypi-upload@v5
with:
password: ${{ secrets.PYPI_API_TOKEN_JAVA_API_PKG }}
working-directory: java-api

- name: Upload ignition-api-stubs to PyPI
uses: coatl-dev/actions/pypi-upload@v5
with:
python-version: '3.12'
password: ${{ secrets.PYPI_API_TOKEN_JAVA_API_STUBS }}
working-directory: java-api-stubs
4 changes: 2 additions & 2 deletions java-api-stubs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ files were generated using `mypy`'s [`stubgen`].
## Installation and usage

To use java-api-stubs, you may install it with `pip`. It requires Python
3.7+ through 3.12.
3.7 through 3.12.

> [!WARNING]
> Python 3.13 will not be supported.

```sh
python3 -m pip install \
git+https://github.com/ignition-devs/java-api-17.git#subdirectory=java-api-stubs \
java-api-stubs \
"mypy[python2]==0.971"
```

Expand Down
6 changes: 3 additions & 3 deletions java-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The preferred method is to install it by running `pip`. It requires Python
2.7.18.

```bash
python2 -m pip install git+https://github.com/ignition-devs/java-api-17.git#subdirectory=java-api
python2 -m pip install java-api
```

This will install it as package to your Python installation, which will allow
Expand All @@ -41,8 +41,8 @@ completion using an IDE such as PyCharm and Visual Studio Code.

```bash
$ python2
Python 2.7.18 (default, Nov 9 2020, 16:23:15)
[GCC Apple LLVM 12.0.0 (clang-1200.0.32.21)] on darwin
Python 2.7.18 (default, Sep 23 2024, 13:23:35)
[GCC Apple LLVM 16.0.0 (clang-1600.0.26.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from __future__ import print_function
>>> import java.lang
Expand Down