Skip to content

Added clear instruction in the Developer Guide regarding setting the … #45

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
cmworkato merged 1 commit into from
Jan 14, 2026
Merged

Added clear instruction in the Developer Guide regarding setting the … #45

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
23 changes: 23 additions & 0 deletions docs/DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,27 @@ If you want to contribute to the Workato CLI codebase itself, use these developm
make test # Run tests and check code style
```

### Testing with Test PyPI

When testing pre-release versions from Test PyPI, you need to use both Test PyPI and regular PyPI to resolve dependencies:

**Using pipx (Recommended):**
```bash
pipx install \
--index-url https://test.pypi.org/simple/ \
--pip-args="--extra-index-url https://pypi.org/simple/" \
workato-platform-cli
```

**Using pip:**
```bash
pip install \
--index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple/ \
workato-platform-cli
```

**Why this is needed:**
Some dependencies (like `aiohttp-retry`) are not available on Test PyPI. Using `--extra-index-url` tells pip to fall back to the regular PyPI index when a package is not found on Test PyPI.

These commands are for CLI maintainers and contributors, not for developers using the CLI to build Workato integrations.