From 526dc06e2fcb295d632a1d9cdbbf02fd06df36db Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Wed, 24 Sep 2025 15:14:10 -0500 Subject: [PATCH 1/2] docs: Replace @v0.2 with @v0 and recommend pinning --- analyze-project/README.md | 4 ++++ check-project-version/README.md | 14 +++++++++----- setup-poetry/README.md | 12 ++++++++---- setup-python/README.md | 12 ++++++++---- update-project-version/README.md | 20 ++++++++++++-------- 5 files changed, 41 insertions(+), 21 deletions(-) diff --git a/analyze-project/README.md b/analyze-project/README.md index 0af04f6..4ea97fe 100644 --- a/analyze-project/README.md +++ b/analyze-project/README.md @@ -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 diff --git a/check-project-version/README.md b/check-project-version/README.md index fde7ab7..32004af 100644 --- a/check-project-version/README.md +++ b/check-project-version/README.md @@ -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' ``` @@ -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 ``` @@ -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 }} ``` diff --git a/setup-poetry/README.md b/setup-poetry/README.md index f5553b3..1aca2cd 100644 --- a/setup-poetry/README.md +++ b/setup-poetry/README.md @@ -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 ``` @@ -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 diff --git a/setup-python/README.md b/setup-python/README.md index 5b2b0b0..402def4 100644 --- a/setup-python/README.md +++ b/setup-python/README.md @@ -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 @@ -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 }} ``` @@ -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: @@ -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 --python ${{ steps.setup-python.outputs.python-version }} ``` diff --git a/update-project-version/README.md b/update-project-version/README.md index 49c0b01..39ed7d2 100644 --- a/update-project-version/README.md +++ b/update-project-version/README.md @@ -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 @@ -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 ``` @@ -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/ ``` @@ -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 From bc5803d3a150b971d0fd1012f3222572c65b419a Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Wed, 24 Sep 2025 15:32:20 -0500 Subject: [PATCH 2/2] docs: Update note syntax --- analyze-project/README.md | 2 +- check-project-version/README.md | 2 +- setup-poetry/README.md | 2 +- setup-python/README.md | 2 +- update-project-version/README.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/analyze-project/README.md b/analyze-project/README.md index 4ea97fe..4c48b04 100644 --- a/analyze-project/README.md +++ b/analyze-project/README.md @@ -10,7 +10,7 @@ This action requires Poetry, so you must call `ni/python-actions/setup-python` a ## Usage -> **Note** +> [!NOTE] > These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for > build reproducibility and security. diff --git a/check-project-version/README.md b/check-project-version/README.md index 32004af..b13e9af 100644 --- a/check-project-version/README.md +++ b/check-project-version/README.md @@ -12,7 +12,7 @@ This action requires Poetry, so you must call `ni/python-actions/setup-python` a ## Usage -> **Note** +> [!NOTE] > These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for > build reproducibility and security. diff --git a/setup-poetry/README.md b/setup-poetry/README.md index 1aca2cd..fa38995 100644 --- a/setup-poetry/README.md +++ b/setup-poetry/README.md @@ -10,7 +10,7 @@ By default, this action installs Poetry 2.1.4. ## Usage -> **Note** +> [!NOTE] > These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for > build reproducibility and security. diff --git a/setup-python/README.md b/setup-python/README.md index 402def4..d6c4f14 100644 --- a/setup-python/README.md +++ b/setup-python/README.md @@ -9,7 +9,7 @@ By default, this action installs Python 3.11.9. ## Usage -> **Note** +> [!NOTE] > These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for > build reproducibility and security. diff --git a/update-project-version/README.md b/update-project-version/README.md index 39ed7d2..867ba85 100644 --- a/update-project-version/README.md +++ b/update-project-version/README.md @@ -18,7 +18,7 @@ permissions: ## Usage -> **Note** +> [!NOTE] > These examples use `@v0`, but pinning to a commit hash or full release tag is recommended for > build reproducibility and security.