Skip to content

Add "version: PATH" to pull pyright from $PATH #107

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
merged 7 commits into from
Apr 11, 2024
+1,038 −102
Merged

Add "version: PATH" to pull pyright from $PATH #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
373dbfe
Start to pass info around for changing the command
jakebailey Apr 10, 2024
17f250d
mostly working
jakebailey Apr 10, 2024
02468ae
Smoke test
jakebailey Apr 10, 2024
ebae65e
test more
jakebailey Apr 10, 2024
d310346
Update readme
jakebailey Apr 10, 2024
cf8a99b
Docs
jakebailey Apr 10, 2024
6661384
Update .github/workflows/ci.yml
jakebailey Apr 10, 2024
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
8 changes: 8 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,11 @@ jobs:
- uses: ./
with:
working-directory: ./smoke-test

- uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
- run: pip install pyright

- uses: ./
with:
working-directory: ./smoke-test
version: PATH
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ GitHub action for [pyright](https://github.com/microsoft/pyright). Featuring:
inputs:
# Options for pyright-action
version:
description: 'Version of pyright to run. If neither version nor pylance-version are specified, the latest version will be used.'
description: 'Version of pyright to run, or "PATH" to use pyright from $PATH. If neither version nor pylance-version are specified, the latest version will be used.'
required: false
pylance-version:
description: 'Version of pylance whose pyright version should be run. Can be latest-release, latest-prerelease, or a specific pylance version. Ignored if version option is specified.'
Expand Down Expand Up @@ -143,7 +143,31 @@ poetry's python binary is on `$PATH`:
- uses: jakebailey/pyright-action@v2
```

## Keeping Pyright and Pylance in sync
## Providing a pyright version sourced from preexisting dependencies

The `version` input only accepts "latest" or a specific version number. However,
there are many ways to use specify a version of `pyright` derived from other
tools.

### Using pyright from `$PATH`

If you have `pyright` installed in your environment, e.g. via the `pyright` PyPI
package, specify `version: PATH` to use the version that's on `$PATH`.

```yml
- run: |
python -m venv .venv
source .venv/bin/activate
pip install -r dev-requirements.txt # includes pyright

- run: echo "$PWD/.venv/bin" >> $GITHUB_PATH

- uses: jakebailey/pyright-action@v2
with:
version: PATH
```

### Keeping Pyright and Pylance in sync

If you use Pylance as your language server, you'll likely want pyright-action to
use the same version of `pyright` that Pylance does. The `pylance-version`
Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ branding:
inputs:
# Options for pyright-action
version:
description: 'Version of pyright to run. If neither version nor pylance-version are specified, the latest version will be used.'
description: 'Version of pyright to run, or "PATH" to use pyright from $PATH. If neither version nor pylance-version are specified, the latest version will be used.'
required: false
pylance-version:
description: 'Version of pylance whose pyright version should be run. Can be latest-release, latest-prerelease, or a specific pylance version. Ignored if version option is specified.'
Expand Down
Loading