diff --git a/README.md b/README.md index fc55cc2..b134f3b 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ single-sourcing the default Python version for multiple NI Python projects. - [`ni/python-actions/setup-poetry`](setup-poetry): installs Poetry, adds it to the PATH, and caches it to speed up workflows. +- [`ni/python-actions/analyze-project`](analyze-project): analyzes the code quality of a Python + project using various linters and type checkers. - [`ni/python-actions/check-project-version`](check-project-version): uses Poetry to get the version of a Python project and checks that it matches an expected version. Publish workflows can use this to verify that the release tag matches the version number in `pyproject.toml`. diff --git a/analyze-project/README.md b/analyze-project/README.md index 0af04f6..43e2852 100644 --- a/analyze-project/README.md +++ b/analyze-project/README.md @@ -1,6 +1,6 @@ # `ni/python-actions/analyze-project` -The `ni/python-actions/update-project-version` action analyzes the code quality +The `ni/python-actions/analyze-project` action analyzes the code quality of a Python project using various linters and type checkers including ni-python-styleguide, mypy (if the 'mypy' package is installed), and pyright (if the 'pyright' package is installed).