Skip to content

Commit 1b64ebd

Browse files
committed
docs: Use ni/python-actions/ when referring to specific actions
1 parent 2540f2e commit 1b64ebd

File tree

4 files changed

+15
-13
lines changed

4 files changed

+15
-13
lines changed

check-project-version/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# `ni/python-actions/check-project-version`
22

3-
The `check-project-version` action uses Poetry to get the version of a Python project and checks
4-
that it matches an expected version. Publish workflows can use this to verify that the release tag
5-
matches the version number in `pyproject.toml`.
3+
The `ni/python-actions/check-project-version` action uses Poetry to get the version of a Python
4+
project and checks that it matches an expected version. Publish workflows can use this to verify
5+
that the release tag matches the version number in `pyproject.toml`.
66

77
By default, this action checks against `github.ref_name`, which is the GitHub release tag for GitHub
88
release events.
99

10-
This action requires Poetry, so you must call `setup-python` and `setup-poetry` first.
10+
This action requires Poetry, so you must call `ni/python-actions/setup-python` and
11+
`ni/python-actions/setup-poetry` first.
1112

1213
## Usage
1314

setup-poetry/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# `ni/python-actions/setup-poetry`
22

3-
The `setup-poetry` action installs Poetry, adds it to the PATH, and caches it to speed up
4-
workflows.
3+
The `ni/python-actions/setup-poetry` action installs Poetry, adds it to the PATH, and caches it to
4+
speed up workflows.
55

6-
This action installs Poetry using the Python version that was selected by the `setup-python`
7-
action, so you must call `setup-python` first.
6+
This action installs Poetry using the Python version that was selected by the
7+
`ni/python-actions/setup-python` action, so you must call `ni/python-actions/setup-python` first.
88

99
By default, this action installs Poetry 2.1.4.
1010

setup-python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `ni/python-actions/setup-python`
22

3-
The `setup-python` action installs Python and adds it to the PATH.
3+
The `ni/python-actions/setup-python` action installs Python and adds it to the PATH.
44

55
It is a thin wrapper for https://github.com/actions/setup-python which is intended to
66
single-source the default Python version for multiple NI Python projects.

update-project-version/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# `ni/python-actions/update-project-version`
22

3-
The `update-project-version` action uses Poetry to update the version of a Python project and
4-
creates a pull request to modify its `pyproject.toml` file. Publish workflows can use this to update
5-
the version in `pyproject.toml` for the next build.
3+
The `ni/python-actions/update-project-version` action uses Poetry to update the version of a Python
4+
project and creates a pull request to modify its `pyproject.toml` file. Publish workflows can use
5+
this to update the version in `pyproject.toml` for the next build.
66

7-
This action requires Poetry, so you must call `setup-python` and `setup-poetry` first.
7+
This action requires Poetry, so you must call `ni/python-actions/setup-python` and
8+
`ni/python-actions/setup-poetry` first.
89

910
Creating a pull request requires the workflow or job to have the following `GITHUB_TOKEN`
1011
permissions:

0 commit comments

Comments
 (0)