Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions analyze-project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ This action requires Poetry, so you must call `ni/python-actions/setup-python` a

## Usage

> [!NOTE]
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
> build reproducibility and security.

```yaml
steps:
- uses: ni/python-actions/setup-python@v0
Expand Down
14 changes: 9 additions & 5 deletions check-project-version/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ This action requires Poetry, so you must call `ni/python-actions/setup-python` a

## Usage

> [!NOTE]
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
> build reproducibility and security.

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-poetry@v0.2
- uses: ni/python-actions/check-project-version@v0.2
- uses: ni/python-actions/setup-python@v0
- uses: ni/python-actions/setup-poetry@v0
- uses: ni/python-actions/check-project-version@v0
if: github.event_name == 'release'
```

Expand All @@ -27,7 +31,7 @@ steps:
You can specify `project-directory` to check a project located in a subdirectory.

```yaml
- uses: ni/python-actions/check-project-version@v0.2
- uses: ni/python-actions/check-project-version@v0
with:
project-directory: packages/foo
```
Expand All @@ -37,7 +41,7 @@ You can specify `project-directory` to check a project located in a subdirectory
You can specify `expected-version` to check against something other than `github.ref_name`.

```yaml
- uses: ni/python-actions/check-project-version@v0.2
- uses: ni/python-actions/check-project-version@v0
with:
expected-version: ${{ steps.get-expected-version.outputs.version }}
```
12 changes: 8 additions & 4 deletions setup-poetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ By default, this action installs Poetry 2.1.4.

## Usage

> [!NOTE]
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
> build reproducibility and security.

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-poetry@v0.2
- uses: ni/python-actions/setup-python@v0
- uses: ni/python-actions/setup-poetry@v0
- run: poetry install -v
```

Expand All @@ -23,8 +27,8 @@ steps:

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-poetry@v0.2
- uses: ni/python-actions/setup-python@v0
- uses: ni/python-actions/setup-poetry@v0
with:
poetry-version: 2.1.4
- run: poetry install -v
Expand Down
12 changes: 8 additions & 4 deletions setup-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,13 @@ By default, this action installs Python 3.11.9.

## Usage

> [!NOTE]
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
> build reproducibility and security.

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-python@v0
```

## Inputs
Expand All @@ -25,7 +29,7 @@ strategy:
matrix:
python-version: [3.9, '3.10', 3.11, 3.12, 3.13]
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-python@v0
with:
python-version: ${{ matrix.python-version }}
```
Expand All @@ -38,7 +42,7 @@ You can use the `python-version` output to get the actual version of Python, whi

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-python@v0
id: setup-python
- uses: actions/cache@v4
with:
Expand All @@ -61,7 +65,7 @@ You can also use the `python-path` output to get the path to the Python interpre

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-python@v0
id: setup-python
- run: pipx install <package> --python ${{ steps.setup-python.outputs.python-version }}
```
Expand Down
20 changes: 12 additions & 8 deletions update-project-version/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,15 @@ permissions:

## Usage

> [!NOTE]
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
> build reproducibility and security.

```yaml
steps:
- uses: ni/python-actions/setup-python@v0.2
- uses: ni/python-actions/setup-poetry@v0.2
- uses: ni/python-actions/update-project-version@v0.2
- uses: ni/python-actions/setup-python@v0
- uses: ni/python-actions/setup-poetry@v0
- uses: ni/python-actions/update-project-version@v0
```

## Inputs
Expand All @@ -32,7 +36,7 @@ steps:
You can specify `project-directory` to update a project located in a subdirectory.

```yaml
- uses: ni/python-actions/update-project-version@v0.2
- uses: ni/python-actions/update-project-version@v0
with:
project-directory: packages/foo
```
Expand All @@ -44,7 +48,7 @@ You can specify `branch-prefix` to customize the pull request branch names. The
`users/build/update-project-version-releases-1.1`.

```yaml
- uses: ni/python-actions/update-project-version@v0.2
- uses: ni/python-actions/update-project-version@v0
with:
branch-prefix: users/python-build/
```
Expand All @@ -55,15 +59,15 @@ You can use `create-pull-request` and `project-directory` to update multiple pro
pull request.

```yaml
- uses: ni/python-actions/update-project-version@v0.2
- uses: ni/python-actions/update-project-version@v0
with:
project-directory: packages/foo
create-pull-request: false
- uses: ni/python-actions/update-project-version@v0.2
- uses: ni/python-actions/update-project-version@v0
with:
project-directory: packages/bar
create-pull-request: false
- uses: ni/python-actions/update-project-version@v0.2
- uses: ni/python-actions/update-project-version@v0
with:
project-directory: packages/baz
create-pull-request: true
Expand Down
Loading