Skip to content

Commit f46b3c5

Browse files
authored
docs: Replace @v0.2 with @v0 and recommend pinning (#29)
* docs: Replace @v0.2 with @v0 and recommend pinning * docs: Update note syntax
1 parent 1b90235 commit f46b3c5

File tree

5 files changed

+41
-21
lines changed

5 files changed

+41
-21
lines changed

analyze-project/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ This action requires Poetry, so you must call `ni/python-actions/setup-python` a
1010

1111
## Usage
1212

13+
> [!NOTE]
14+
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
15+
> build reproducibility and security.
16+
1317
```yaml
1418
steps:
1519
- uses: ni/python-actions/setup-python@v0

check-project-version/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ This action requires Poetry, so you must call `ni/python-actions/setup-python` a
1212

1313
## Usage
1414

15+
> [!NOTE]
16+
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
17+
> build reproducibility and security.
18+
1519
```yaml
1620
steps:
17-
- uses: ni/python-actions/setup-python@v0.2
18-
- uses: ni/python-actions/setup-poetry@v0.2
19-
- uses: ni/python-actions/check-project-version@v0.2
21+
- uses: ni/python-actions/setup-python@v0
22+
- uses: ni/python-actions/setup-poetry@v0
23+
- uses: ni/python-actions/check-project-version@v0
2024
if: github.event_name == 'release'
2125
```
2226
@@ -27,7 +31,7 @@ steps:
2731
You can specify `project-directory` to check a project located in a subdirectory.
2832

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

3943
```yaml
40-
- uses: ni/python-actions/check-project-version@v0.2
44+
- uses: ni/python-actions/check-project-version@v0
4145
with:
4246
expected-version: ${{ steps.get-expected-version.outputs.version }}
4347
```

setup-poetry/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@ By default, this action installs Poetry 2.1.4.
1010

1111
## Usage
1212

13+
> [!NOTE]
14+
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
15+
> build reproducibility and security.
16+
1317
```yaml
1418
steps:
15-
- uses: ni/python-actions/setup-python@v0.2
16-
- uses: ni/python-actions/setup-poetry@v0.2
19+
- uses: ni/python-actions/setup-python@v0
20+
- uses: ni/python-actions/setup-poetry@v0
1721
- run: poetry install -v
1822
```
1923
@@ -23,8 +27,8 @@ steps:
2327

2428
```yaml
2529
steps:
26-
- uses: ni/python-actions/setup-python@v0.2
27-
- uses: ni/python-actions/setup-poetry@v0.2
30+
- uses: ni/python-actions/setup-python@v0
31+
- uses: ni/python-actions/setup-poetry@v0
2832
with:
2933
poetry-version: 2.1.4
3034
- run: poetry install -v

setup-python/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@ By default, this action installs Python 3.11.9.
99

1010
## Usage
1111

12+
> [!NOTE]
13+
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
14+
> build reproducibility and security.
15+
1216
```yaml
1317
steps:
14-
- uses: ni/python-actions/setup-python@v0.2
18+
- uses: ni/python-actions/setup-python@v0
1519
```
1620
1721
## Inputs
@@ -25,7 +29,7 @@ strategy:
2529
matrix:
2630
python-version: [3.9, '3.10', 3.11, 3.12, 3.13]
2731
steps:
28-
- uses: ni/python-actions/setup-python@v0.2
32+
- uses: ni/python-actions/setup-python@v0
2933
with:
3034
python-version: ${{ matrix.python-version }}
3135
```
@@ -38,7 +42,7 @@ You can use the `python-version` output to get the actual version of Python, whi
3842

3943
```yaml
4044
steps:
41-
- uses: ni/python-actions/setup-python@v0.2
45+
- uses: ni/python-actions/setup-python@v0
4246
id: setup-python
4347
- uses: actions/cache@v4
4448
with:
@@ -61,7 +65,7 @@ You can also use the `python-path` output to get the path to the Python interpre
6165

6266
```yaml
6367
steps:
64-
- uses: ni/python-actions/setup-python@v0.2
68+
- uses: ni/python-actions/setup-python@v0
6569
id: setup-python
6670
- run: pipx install <package> --python ${{ steps.setup-python.outputs.python-version }}
6771
```

update-project-version/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,15 @@ permissions:
1818

1919
## Usage
2020

21+
> [!NOTE]
22+
> These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for
23+
> build reproducibility and security.
24+
2125
```yaml
2226
steps:
23-
- uses: ni/python-actions/setup-python@v0.2
24-
- uses: ni/python-actions/setup-poetry@v0.2
25-
- uses: ni/python-actions/update-project-version@v0.2
27+
- uses: ni/python-actions/setup-python@v0
28+
- uses: ni/python-actions/setup-poetry@v0
29+
- uses: ni/python-actions/update-project-version@v0
2630
```
2731

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

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

4650
```yaml
47-
- uses: ni/python-actions/update-project-version@v0.2
51+
- uses: ni/python-actions/update-project-version@v0
4852
with:
4953
branch-prefix: users/python-build/
5054
```
@@ -55,15 +59,15 @@ You can use `create-pull-request` and `project-directory` to update multiple pro
5559
pull request.
5660

5761
```yaml
58-
- uses: ni/python-actions/update-project-version@v0.2
62+
- uses: ni/python-actions/update-project-version@v0
5963
with:
6064
project-directory: packages/foo
6165
create-pull-request: false
62-
- uses: ni/python-actions/update-project-version@v0.2
66+
- uses: ni/python-actions/update-project-version@v0
6367
with:
6468
project-directory: packages/bar
6569
create-pull-request: false
66-
- uses: ni/python-actions/update-project-version@v0.2
70+
- uses: ni/python-actions/update-project-version@v0
6771
with:
6872
project-directory: packages/baz
6973
create-pull-request: true

0 commit comments

Comments
 (0)