From 9c0ba0c1b3a48744baadebe8db2ac155a4bc2eb7 Mon Sep 17 00:00:00 2001
From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Date: Wed, 7 Aug 2024 09:05:32 +0200
Subject: [PATCH 1/4] fix: add missing changelog docs
---
doc/source/doc-actions/index.rst | 42 ++++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/doc/source/doc-actions/index.rst b/doc/source/doc-actions/index.rst
index f0c52f92c..466e4f46e 100644
--- a/doc/source/doc-actions/index.rst
+++ b/doc/source/doc-actions/index.rst
@@ -93,3 +93,45 @@ Doc deploy index action
:language: yaml
{% endfor %}
+
+Doc changelog action
+--------------------
+
+.. jinja:: doc-changelog
+
+ {{ description }}
+
+ {{ inputs_table }}
+
+ Examples
+ ++++++++
+
+ {% for filename, title in examples %}
+ .. dropdown:: {{ title }}
+ :animate: fade-in
+
+ .. literalinclude:: examples/{{ filename }}
+ :language: yaml
+
+ {% endfor %}
+
+Doc deploy changelog action
+---------------------------
+
+.. jinja:: doc-deploy-changelog
+
+ {{ description }}
+
+ {{ inputs_table }}
+
+ Examples
+ ++++++++
+
+ {% for filename, title in examples %}
+ .. dropdown:: {{ title }}
+ :animate: fade-in
+
+ .. literalinclude:: examples/{{ filename }}
+ :language: yaml
+
+ {% endfor %}
From b8ae596840dda39ce92c2dda3fd31728db9c4761 Mon Sep 17 00:00:00 2001
From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Date: Wed, 7 Aug 2024 09:05:49 +0200
Subject: [PATCH 2/4] fix: properly format inputs from actions
---
_doc-build-linux/action.yml | 12 ++++++------
_doc-build-windows/action.yml | 14 +++++++-------
_doc-gen-canonical/action.yml | 4 ++--
_doc-gen-robots/action.yml | 2 +-
_doc-gen-sitemap/action.yml | 4 ++--
_doc-gen-versions-page/action.yml | 4 ++--
_logging/action.yml | 6 +++---
_release-pypi/action.yml | 18 +++++++++---------
build-ci-wheels/action.yml | 12 ++++++------
build-library/action.yml | 8 ++++----
build-wheelhouse/action.yml | 14 +++++++-------
check-licenses/action.yml | 10 +++++-----
check-vulnerabilities/action.yml | 24 ++++++++++++------------
code-style/action.yml | 12 ++++++------
commit-style/action.yml | 6 +++---
doc-build/action.yml | 24 ++++++++++++------------
doc-changelog/action.yml | 14 +++++++-------
doc-deploy-changelog/action.yml | 17 ++++++++---------
doc-deploy-dev/action.yml | 18 +++++++++---------
doc-deploy-index/action.yml | 18 +++++++++---------
doc-deploy-stable/action.yml | 22 +++++++++++-----------
doc-style/action.yml | 16 ++++++++--------
docker-style/action.yml | 8 ++++----
release-github/action.yml | 8 ++++----
release-pypi-private/action.yml | 16 ++++++++--------
release-pypi-public/action.yml | 14 +++++++-------
release-pypi-test/action.yml | 14 +++++++-------
tests-pytest/action.yml | 18 +++++++++---------
28 files changed, 178 insertions(+), 179 deletions(-)
diff --git a/_doc-build-linux/action.yml b/_doc-build-linux/action.yml
index e76449d11..e1ef19d09 100644
--- a/_doc-build-linux/action.yml
+++ b/_doc-build-linux/action.yml
@@ -54,14 +54,14 @@ inputs:
type: string
dependencies:
- description: >
+ description: |
String of system dependencies to be installed before building the
documentation of the project.
required: true
type: string
skip-dependencies-cache:
- description: >
+ description: |
Whether to ignore dependencies cache or not - for OS libraries.
required: true
type: boolean
@@ -75,7 +75,7 @@ inputs:
type: boolean
skip-install:
- description: >
+ description: |
Whether to skip the installation of the project.
Pure documentation projects require that this action be set to ``false``
because there is no Python library associated with the project.
@@ -83,7 +83,7 @@ inputs:
type: boolean
requirements-file:
- description: >
+ description: |
Path to the requirements file in case it needs to be in a specific location.
This is useful for non python projects, where you don't necessarily have a requirements
file in the root of the project.
@@ -91,13 +91,13 @@ inputs:
type: string
skip-json-build:
- description: >
+ description: |
Whether to skip the generation of JSON documentation.
required: true
type: boolean
check-links:
- description: >
+ description: |
Whether to perform external link checks during the generation of
documentation.
required: true
diff --git a/_doc-build-windows/action.yml b/_doc-build-windows/action.yml
index 69ca92c32..0f182fad0 100644
--- a/_doc-build-windows/action.yml
+++ b/_doc-build-windows/action.yml
@@ -43,7 +43,7 @@ inputs:
# Required inputs
sphinxopts:
- description: >
+ description: |
Set of options to pass to the ``Sphinx`` builder.
.. note::
@@ -54,20 +54,20 @@ inputs:
type: string
dependencies:
- description: >
+ description: |
String of system dependencies to be installed before building the
documentation of the project.
required: true
type: string
skip-dependencies-cache:
- description: >
+ description: |
Whether to ignore dependencies cache or not for OS libraries.
required: true
type: boolean
skip-install:
- description: >
+ description: |
Whether to skip the installation of the project.
Pure documentation projects require that this action be set to ``false``
because there is no Python library associated with the project.
@@ -75,7 +75,7 @@ inputs:
type: boolean
requirements-file:
- description: >
+ description: |
Path to the requirements file in case it needs to be in a specific location.
This is useful for non python projects, where you don't necessarily have a requirements
file in the root of the project.
@@ -83,13 +83,13 @@ inputs:
type: string
skip-json-build:
- description: >
+ description: |
Whether to skip the generation of JSON documentation.
required: true
type: boolean
check-links:
- description: >
+ description: |
Whether to perform external link checks during the generation of
documentation.
required: true
diff --git a/_doc-gen-canonical/action.yml b/_doc-gen-canonical/action.yml
index b586d31dd..3f6f57cce 100644
--- a/_doc-gen-canonical/action.yml
+++ b/_doc-gen-canonical/action.yml
@@ -33,13 +33,13 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
version-directory:
- description: >
+ description: |
Relative path to the directory containing the version pages of the website.
required: true
type: string
diff --git a/_doc-gen-robots/action.yml b/_doc-gen-robots/action.yml
index 95b2be0ee..23b508165 100644
--- a/_doc-gen-robots/action.yml
+++ b/_doc-gen-robots/action.yml
@@ -34,7 +34,7 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
diff --git a/_doc-gen-sitemap/action.yml b/_doc-gen-sitemap/action.yml
index d0f0b70f3..b323c2091 100644
--- a/_doc-gen-sitemap/action.yml
+++ b/_doc-gen-sitemap/action.yml
@@ -34,13 +34,13 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
html-directory:
- description: >
+ description: |
Name of the directory containing the HTML files of the website.
required: true
type: string
diff --git a/_doc-gen-versions-page/action.yml b/_doc-gen-versions-page/action.yml
index eeb639643..a78b3bffe 100644
--- a/_doc-gen-versions-page/action.yml
+++ b/_doc-gen-versions-page/action.yml
@@ -39,13 +39,13 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
content-element-id:
- description: >
+ description: |
Identifier of the HTML tag that comprises all the content of the article
or post.
required: true
diff --git a/_logging/action.yml b/_logging/action.yml
index f6a8ab9f5..488b0dc48 100644
--- a/_logging/action.yml
+++ b/_logging/action.yml
@@ -23,7 +23,7 @@
name: >
Utils logging action
-description: >
+description: |
This action is used to generate logging messages during the execution of other
actions. It supports three logging levels including ``ERROR``, ``WARNING``,
and ``INFO``. ANSI colors are used to report the different levels. This allows
@@ -34,14 +34,14 @@ inputs:
# Required inputs
level:
- description: >
+ description: |
Logging level of the message. Supported levels are ``ERROR``, ``WARNING``
and ``INFO``.
required: true
type: string
message:
- description: >
+ description: |
The message to save in the logging report.
required: true
type: string
diff --git a/_release-pypi/action.yml b/_release-pypi/action.yml
index ef12c83d9..936b5fc09 100644
--- a/_release-pypi/action.yml
+++ b/_release-pypi/action.yml
@@ -23,7 +23,7 @@
name: >
Release PyPI action
-description: >
+description: |
Release library artifacts to the desired PyPI index. If a private index is
used, a ``token`` is required to publish the artifacts. Artifacts are
downloaded from the CI/CD pipeline and are assumed to be named
@@ -35,38 +35,38 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library to be published.
required: true
type: string
index-name:
- description: >
+ description: |
The name of the index endpoint used for uploading the artifacts.
required: true
type: string
twine-username:
- description: >
+ description: |
User name used when uploading the artifacts to the desired PyPI index.
required: true
type: string
twine-token:
- description: >
+ description: |
Password used when uploading the artifacts to the desired PyPI index.
required: true
type: string
python-version:
- description: >
+ description: |
Python version for installing and using `twine
`_.
required: true
type: string
dry-run:
- description: >
+ description: |
Whether to run or not this action in testing mode. Testing mode executes
all the action steps except the releasing artifacts one. This allows
developers to verify the health of the action once integrated in their
@@ -75,14 +75,14 @@ inputs:
type: boolean
skip-existing:
- description: >
+ description: |
Continue uploading files if one already exists. Only valid when uploading
to PyPI. Other implementations may not support this.
required: true
type: boolean
use-trusted-publisher:
- description: >
+ description: |
Whether to use the OIDC token for releasing.
This is useful when you want to publish to PyPI through a CI/CD pipeline
as a Trusted Publisher. It is necessary that your repository has been authorized
diff --git a/build-ci-wheels/action.yml b/build-ci-wheels/action.yml
index 3cc34e1cf..5ef7978c7 100644
--- a/build-ci-wheels/action.yml
+++ b/build-ci-wheels/action.yml
@@ -40,13 +40,13 @@ inputs:
# Required inputs
python-version:
- description: >
+ description: |
Python version used for building the wheels.
required: true
type: string
library-name:
- description: >
+ description: |
Name of the Python library. This is the name used when uploading the wheel
and source distribution as artifacts. The name should be the same one used
in the PyPI index.
@@ -54,7 +54,7 @@ inputs:
type: string
operating-system:
- description: >
+ description: |
Name of the operating system where the library is installed.
required: true
type: string
@@ -62,21 +62,21 @@ inputs:
# Optional inputs
cibw-build:
- description: >
+ description: |
Desired build wheel CPython version.
default: 'cp310-*'
required: false
type: string
cibw-archs:
- description: >
+ description: |
Desired build architecture.
default: "auto"
required: false
type: string
requires-pypy:
- description: >
+ description: |
Whether to generate wheels for wheel files for `PyPy
`_ in addition to the wheel files for CPython.
Default value is ``false``.
diff --git a/build-library/action.yml b/build-library/action.yml
index 318537ba5..5a8a17c95 100644
--- a/build-library/action.yml
+++ b/build-library/action.yml
@@ -39,7 +39,7 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library. This is the name used when uploading the wheel
and source distribution as artifacts. The name should be the same one used
in the PyPI index.
@@ -49,14 +49,14 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for installing and execution of the build process.
default: '3.10'
required: false
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -65,7 +65,7 @@ inputs:
type: boolean
validate-build:
- description: >
+ description: |
Whether to validate the build process. If ``true``, the build process is
validated. If ``false``, the build process is not validated.
required: false
diff --git a/build-wheelhouse/action.yml b/build-wheelhouse/action.yml
index a4fa5e6ab..208e9d7e1 100644
--- a/build-wheelhouse/action.yml
+++ b/build-wheelhouse/action.yml
@@ -39,7 +39,7 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library. This is the name used when uploading the wheel
and source distribution as artifacts. The name should be the same one used
in the PyPI index.
@@ -47,13 +47,13 @@ inputs:
type: string
operating-system:
- description: >
+ description: |
Name of the operating system where the library is installed.
required: true
type: string
python-version:
- description: >
+ description: |
Python version used for installing and execution of the build wheel process.
required: true
type: string
@@ -61,14 +61,14 @@ inputs:
# Optional inputs
target:
- description: >
+ description: |
Optional target used during the building process.
required: false
default: ''
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -77,7 +77,7 @@ inputs:
type: boolean
check-licenses:
- description: >
+ description: |
Whether to check the library's dependencies license or not. If ``true``. the licenses
are checked. If ``false``, no license check is performed. By default it is set to
``true``.
@@ -86,7 +86,7 @@ inputs:
type: boolean
checkout:
- description: >
+ description: |
Whether to do a checkout step or not. If ``true``, the checkout step is performed.
If ``false``, the checkout is skipped allowing the workspace from a prior step to
be used unaltered. By default it is set to ``true``.
diff --git a/check-licenses/action.yml b/check-licenses/action.yml
index 96e2f55aa..46e1a234a 100644
--- a/check-licenses/action.yml
+++ b/check-licenses/action.yml
@@ -69,14 +69,14 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for installing and executing licence check.
default: '3.10'
required: false
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -85,14 +85,14 @@ inputs:
type: boolean
target:
- description: >
+ description: |
Optional target used during the building process.
required: false
default: ''
type: string
skip-install:
- description: >
+ description: |
Whether to skip the installation of the project. The default is ``false``.
If used in combination with other actions, it might not be needed to install
the project.
@@ -101,7 +101,7 @@ inputs:
type: boolean
checkout:
- description: >
+ description: |
Whether to clone the repository in the CI/CD machine. Default value is
``true``.
default: true
diff --git a/check-vulnerabilities/action.yml b/check-vulnerabilities/action.yml
index c5fdace6a..d5e64ba92 100644
--- a/check-vulnerabilities/action.yml
+++ b/check-vulnerabilities/action.yml
@@ -57,13 +57,13 @@ description: |
inputs:
token:
- description: >
+ description: |
Token with write permissions on the repository.
required: true
type: string
python-package-name:
- description: >
+ description: |
Python package name being evaluate as it is shown on PyPI.
required: true
type: string
@@ -71,7 +71,7 @@ inputs:
# Optional inputs
source-directory:
- description: >
+ description: |
The source folder of the repository to be evaluated by bandit.
By default, it is set to ``src``
default: 'src'
@@ -79,7 +79,7 @@ inputs:
type: string
repo-full-name:
- description: >
+ description: |
The repository to be evaluated. By default, it is extracted from the
GitHub context.
default: ''
@@ -87,7 +87,7 @@ inputs:
type: string
dev-mode:
- description: >
+ description: |
Whether to run or not this action in development mode. It will activate
by default the ``dry-run`` and ``exit-with-error-on-new-advisory`` flags.
required: false
@@ -95,7 +95,7 @@ inputs:
type: boolean
dry-run:
- description: >
+ description: |
Whether to run or not this action in dry run mode. Dry run mode executes
all the action steps and prints on screen the results (if any).
required: false
@@ -103,7 +103,7 @@ inputs:
type: boolean
exit-with-error-on-new-advisory:
- description: >
+ description: |
Whether to exit the action on error if a new advisory is detected.
This mode is not recommended on ``main`` branches since it will cause the
workflow to fail. To be used on ``feature`` branches in combination with
@@ -113,7 +113,7 @@ inputs:
type: boolean
hide-log:
- description: >
+ description: |
Whether to hide the output log of the GitHub action.
By default, the log is available to anyone for public repositories.
This would disclose any potential vulnerabilities to anyone.
@@ -122,7 +122,7 @@ inputs:
type: boolean
upload-reports:
- description: >
+ description: |
Whether to upload the artifacts containing the vulnerability report.
By default, the report artifacts will not be uploaded to hide any potential vulnerabilities?
default: false
@@ -130,7 +130,7 @@ inputs:
type: boolean
create-issues:
- description: >
+ description: |
Whether to create issues for new advisories detected.
By default, issues are NOT created for new advisories detected.
default: false
@@ -138,7 +138,7 @@ inputs:
type: boolean
checkout:
- description: >
+ description: |
Whether to clone the repository in the CI/CD machine. Default value is
``true``.
default: true
@@ -146,7 +146,7 @@ inputs:
type: boolean
python-version:
- description: >
+ description: |
Desired Python version.
default: '3.10'
required: false
diff --git a/code-style/action.yml b/code-style/action.yml
index 01398a98e..aa4f64f98 100644
--- a/code-style/action.yml
+++ b/code-style/action.yml
@@ -42,14 +42,14 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for installing and running ``pre-commit``.
default: '3.10'
required: false
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -58,14 +58,14 @@ inputs:
type: boolean
docker-lint:
- description: >
+ description: |
Extend the workflow to lint Dockerfile(s).
required: false
default: false
type: bool
docker-recursive:
- description: >
+ description: |
Search for Dockerfile(s) recursively. Only applies to allowed
directories, i.e. docker and .devcontainer.
required: false
@@ -73,7 +73,7 @@ inputs:
type: bool
docker-error-level:
- description: >
+ description: |
Fail docker-style action based on hadolint output (-1: never, 0: error,
1: warning, 2: info)
required: false
@@ -81,7 +81,7 @@ inputs:
type: int
skip-install:
- description: >
+ description: |
Whether to skip the installation of the project or not. If ``true``, the
project is not installed. If ``false``, the project is installed. By
default, the project is not installed.
diff --git a/commit-style/action.yml b/commit-style/action.yml
index 2c50cea85..ed2201a29 100644
--- a/commit-style/action.yml
+++ b/commit-style/action.yml
@@ -23,7 +23,7 @@
name: >
Commit style
-description: >
+description: |
Action that checks if the title of the pull request is following the
`conventional commits standard
`_.
@@ -33,7 +33,7 @@ inputs:
# Required inputs
token:
- description: >
+ description: |
The token value used to authorize Vale to add comments and suggestions in
the file section.
required: true
@@ -42,7 +42,7 @@ inputs:
# Optional inputs
use-upper-case:
- description: >
+ description: |
Use of uppercase letters in the "type" field of the commit.
For example, "FIX!: fix server crash issue" would be a valid commit.
diff --git a/doc-build/action.yml b/doc-build/action.yml
index cf5f1e061..170bfe689 100644
--- a/doc-build/action.yml
+++ b/doc-build/action.yml
@@ -23,7 +23,7 @@
name: >
Documentation build action
-description: >
+description: |
Build library documentation using `Sphinx
`_. The action installs documentation
dependencies provided either in a requirement file, e.g.
@@ -46,14 +46,14 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for installing and running ``Sphinx``.
default: '3.10'
required: false
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -62,7 +62,7 @@ inputs:
type: boolean
sphinxopts:
- description: >
+ description: |
Set of options to pass to the ``Sphinx`` builder. Default options include
using the maximum number of cores in the CPU of the machine and treating
warnings as errors.
@@ -76,7 +76,7 @@ inputs:
type: string
dependencies:
- description: >
+ description: |
String of system dependencies to be installed before building the
documentation of the project.
default: ''
@@ -84,14 +84,14 @@ inputs:
type: string
skip-dependencies-cache:
- description: >
+ description: |
Whether to ignore dependencies cache or not - for OS libraries.
required: true
default: false
type: boolean
requires-xvfb:
- description: >
+ description: |
Whether to install `X Virtual Frame Buffer (XVFB)
`_ and run
the whole test session using XVFB. The default value is ``false``.
@@ -109,7 +109,7 @@ inputs:
type: boolean
skip-install:
- description: >
+ description: |
Whether to skip the installation of the project. The default is ``false``.
Pure documentation projects require that this action be set to ``false``
because there is no Python library associated with the project.
@@ -118,7 +118,7 @@ inputs:
type: boolean
requirements-file:
- description: >
+ description: |
Path to the requirements file in case it needs to be in a specific location.
This is useful for non python projects, where you don't necessarily have a requirements
file in the root of the project.
@@ -127,7 +127,7 @@ inputs:
type: string
checkout:
- description: >
+ description: |
Whether to clone the repository in the CI/CD machine. Default value is
``true``.
default: true
@@ -135,7 +135,7 @@ inputs:
type: boolean
skip-json-build:
- description: >
+ description: |
Whether to skip the generation of JSON documentation. Default value is
``true``.
default: true
@@ -143,7 +143,7 @@ inputs:
type: boolean
check-links:
- description: >
+ description: |
Whether to perform external link checks during the generation of
documentation. Default value is ``true``.
default: true
diff --git a/doc-changelog/action.yml b/doc-changelog/action.yml
index a99aa3f96..8d2c71b22 100644
--- a/doc-changelog/action.yml
+++ b/doc-changelog/action.yml
@@ -33,7 +33,7 @@ inputs:
# Required inputs
token:
- description: >
+ description: |
Use the PYANSYS_CI_BOT_TOKEN to do a git commit & push.
The "contents: write" and "pull-requests: write" permissions
are required for this action.
@@ -43,28 +43,28 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for setting up Python.
default: '3.10'
required: false
type: string
towncrier-version:
- description: >
+ description: |
Towncrier version used for creating fragment files.
default: '23.11.0'
required: false
type: string
toml-version:
- description: >
+ description: |
Toml version used for retrieving the towncrier directory.
default: '0.10.2'
required: false
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -73,14 +73,14 @@ inputs:
type: boolean
use-conventional-commits:
- description: >
+ description: |
Use conventional commits to cateogrize towncrier fragments.
required: false
default: false
type: boolean
use-default-towncrier-config:
- description: >
+ description: |
Use the default towncrier configuration in the pyproject.toml file.
required: false
default: false
diff --git a/doc-deploy-changelog/action.yml b/doc-deploy-changelog/action.yml
index 36e6acf61..b0d1066fe 100644
--- a/doc-deploy-changelog/action.yml
+++ b/doc-deploy-changelog/action.yml
@@ -34,7 +34,7 @@ inputs:
# Required inputs
token:
- description: >
+ description: |
Use the PYANSYS_CI_BOT_TOKEN to do a git commit & push.
The "contents: write" and "pull-requests: write" permissions
are required for this action.
@@ -44,28 +44,28 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for setting up Python.
default: '3.10'
required: false
type: string
towncrier-version:
- description: >
+ description: |
Towncrier version used for updating the CHANGELOG file.
default: '23.11.0'
required: false
type: string
toml-version:
- description: >
+ description: |
Toml version used for retrieving the towncrier directory.
default: '0.10.2'
required: false
type: string
use-python-cache:
- description: >
+ description:
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -74,7 +74,7 @@ inputs:
type: boolean
update-release-branch:
- description: >
+ description: |
Whether or not to update the CHANGELOG in the release branch.
If ``true``, the branch used to update the CHANGELOG is "release/major.minor".
If ``false``, the branch used to update the CHANGELOG is
@@ -84,7 +84,7 @@ inputs:
type: boolean
update-main-branch:
- description: >
+ description: |
Whether or not to update the CHANGELOG in the main branch.
If ``true``, the branch used to update the CHANGELOG is main.
If ``false``, check the value of the update-release-branch input.
@@ -93,7 +93,7 @@ inputs:
type: boolean
use-upper-case:
- description: >
+ description: |
Use of uppercase letters in the "type" field of:
- The PR created into main to add CHANGELOG changes.
@@ -101,7 +101,6 @@ inputs:
- The commit created in the release branch to add the new
section in CHANGELOG.
-
If ``false``, the title is "chore: ... CHANGELOG for v...".
If ``true``, the title is "CHORE: ... CHANGELOG for v...".
required: false
diff --git a/doc-deploy-dev/action.yml b/doc-deploy-dev/action.yml
index a3fad327c..10ce007c0 100644
--- a/doc-deploy-dev/action.yml
+++ b/doc-deploy-dev/action.yml
@@ -33,13 +33,13 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
token:
- description: >
+ description: |
Required password, key or token with the correct credentials for deploying the
documentation. If deploying to the current repository, the ``secrets.GITHUB_TOKEN`` token
is enough. For workflows deploying to other repositories, `generate and
@@ -52,7 +52,7 @@ inputs:
# Optional inputs
doc-artifact-name:
- description: >
+ description: |
Name of the HTML documentation artifact. This artifact is expected to
contain all the HTML and static files. If it contains a compressed file,
make sure you enable the ``decompress-artifact`` option.
@@ -61,7 +61,7 @@ inputs:
type: string
decompress-artifact:
- description: >
+ description: |
Wether to decompress the artifact using `ouch
`_ as decompression tool. Default value
is ``false``.
@@ -70,7 +70,7 @@ inputs:
type: string
repository:
- description: >
+ description: |
Repository name in the form of ``username/repository`` to be used for
deploying the documentation. The current repository is assumed by default.
required: false
@@ -78,7 +78,7 @@ inputs:
type: string
branch:
- description: >
+ description: |
Branch name for deploying the documentation. The ``gh-pages`` branch is
used by default.
required: false
@@ -86,14 +86,14 @@ inputs:
type: string
commit-message:
- description: >
+ description: |
Commit message used when deploying the documentation.
required: false
default: 'DOC: update development documentation'
type: string
force-orphan:
- description: >
+ description: |
Whether to force the deployment branch to be orphan with only the latest commit or not. Default value
is ``true``.
required: false
@@ -101,7 +101,7 @@ inputs:
type: string
content-element-id:
- description: >
+ description: |
Identifier of the HTML tag that comprises all the content of the article
or post.
required: false
diff --git a/doc-deploy-index/action.yml b/doc-deploy-index/action.yml
index 818b9f3df..685e632bc 100644
--- a/doc-deploy-index/action.yml
+++ b/doc-deploy-index/action.yml
@@ -33,7 +33,7 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The CNAME (canonical Name) that points to the documentation website for a specific version,
specifically intended for scraping purposes.
@@ -44,19 +44,19 @@ inputs:
type: string
index-name:
- description: >
+ description: |
The identifier given to the documentation in pymeilisearch.
required: true
type: string
api-key:
- description: >
+ description: |
The API key used to access the Meilisearch instance host.
required: true
type: string
host-url:
- description: >
+ description: |
The URL where the Meilisearch instance is hosted.
required: true
type: string
@@ -64,14 +64,14 @@ inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for execution of the stable docs scraping.
default: '3.10'
required: false
type: string
doc-artifact-name:
- description: >
+ description: |
The name of the HTML documentation artifact. This artifact is expected to
contain all the HTML and static files.The dafault value is ``documentation-html``.
required: false
@@ -79,7 +79,7 @@ inputs:
type: string
template:
- description: >
+ description: |
The "template" parameter specifies the layout used for the HTML documentation.
By default, it is set to ``sphinx_pydata`` which assumes that the document is
constructed using the pydata-sphinx-theme or its associated theme,
@@ -89,7 +89,7 @@ inputs:
type: string
decompress-artifact:
- description: >
+ description: |
Whether to decompress the ``doc-artifact-name`` file using `ouch
`_ as decompression tool. Default value
is ``false``.
@@ -98,7 +98,7 @@ inputs:
type: string
pymeilisearchopts:
- description: >
+ description: |
A list of pyemeilisearch options when scraping URLs. See
`pymeilisearch user guide `_
for available options
diff --git a/doc-deploy-stable/action.yml b/doc-deploy-stable/action.yml
index 0021799a3..60a41f35b 100644
--- a/doc-deploy-stable/action.yml
+++ b/doc-deploy-stable/action.yml
@@ -38,13 +38,13 @@ inputs:
# Required inputs
cname:
- description: >
+ description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
token:
- description: >
+ description: |
Required password, key or token with the correct credentials for deploying the
documentation. If deploying to the current repository, the ``secrets.GITHUB_TOKEN`` token is
is enough. For workflows deploying to other repositories, `generate and
@@ -57,7 +57,7 @@ inputs:
# Optional inputs
doc-artifact-name:
- description: >
+ description: |
Name of the HTML documentation artifact. This artifact is expected to
contain all the HTML and static files. If it contains a compressed file,
make sure you enable the ``decompress-artifact`` option.
@@ -66,7 +66,7 @@ inputs:
type: string
decompress-artifact:
- description: >
+ description: |
Whether to decompress the ``doc-artifact-name`` file using `ouch
`_ as decompression tool. Default value
is ``false``.
@@ -75,7 +75,7 @@ inputs:
type: string
repository:
- description: >
+ description: |
Repository name in the form of ``username/repository`` to be used for
deploying the documentation. The current repository is assumed by default.
required: false
@@ -83,7 +83,7 @@ inputs:
type: string
branch:
- description: >
+ description: |
Branch name for deploying the documentation. The ``gh-pages`` branch is
used by default.
required: false
@@ -91,14 +91,14 @@ inputs:
type: string
commit-message:
- description: >
+ description: |
Commit message used when deploying the documentation.
required: false
default: 'DOC: update development documentation'
type: string
render-last:
- description: >
+ description: |
The number of stable versions to be shown in the `version drop-down
`_.
default: '3'
@@ -106,7 +106,7 @@ inputs:
type: string
force-orphan:
- description: >
+ description: |
Whether to force the deployment branch to be orphan or not. Default value
is ``true``.
required: false
@@ -114,7 +114,7 @@ inputs:
type: string
content-element-id:
- description: >
+ description: |
Identifier of the HTML tag that comprises all the content of the article
or post.
required: false
@@ -122,7 +122,7 @@ inputs:
type: string
independent-patch-release-docs:
- description: >
+ description: |
Whether to generate documentation for independent patch releases. Default
value is ``false``. By default, patch releases will overwrite the
documentation of the previous patch release. If this option is enabled,
diff --git a/doc-style/action.yml b/doc-style/action.yml
index ba484b2db..e4c5fb0c9 100644
--- a/doc-style/action.yml
+++ b/doc-style/action.yml
@@ -23,7 +23,7 @@
name: >
Documentation style
-description: >
+description: |
Check documentation style using `Vale `_. This action is a
wrapper on top of the `errata-ai/vale-action
`_.
@@ -33,7 +33,7 @@ inputs:
# Required inputs
token:
- description: >
+ description: |
The token value used to authorize Vale to add comments and suggestions in
the file section.
required: true
@@ -42,42 +42,42 @@ inputs:
# Optional inputs
files:
- description: >
+ description: |
Path to the directory containing the documentation files.
default: 'doc'
required: false
type: string
vale-config:
- description: >
+ description: |
Path to the Vale configuration file.
default: 'doc/.vale.ini'
required: false
type: string
vale-version:
- description: >
+ description: |
Version number for Vale.
default: '3.4.1'
required: false
type: string
toml-version:
- description: >
+ description: |
Toml version used for retrieving the towncrier directory.
default: '0.10.2'
required: false
type: string
ignore-changelogd:
- description: >
+ description: |
Whether or not to ignore markdown files in doc/changelog.d/.
default: true
required: false
type: bool
checkout:
- description: >
+ description: |
Whether to clone the repository in the CI/CD machine. Default value is
``true``.
default: true
diff --git a/docker-style/action.yml b/docker-style/action.yml
index 64ee26861..0f0b0d7dc 100644
--- a/docker-style/action.yml
+++ b/docker-style/action.yml
@@ -50,7 +50,7 @@ inputs:
# Optional inputs
directory:
- description: >
+ description: |
Directory from which to search for Dockerfile(s). You can pass multiple
directories for processing by separating them with spaces, e.g.
"docker .devcontainer".
@@ -59,14 +59,14 @@ inputs:
type: string
recursive:
- description: >
+ description: |
Search for Dockerfile(s) recursively.
required: false
default: false
type: bool
error-level:
- description: >
+ description: |
Fail action based on hadolint output (-1: never, 0: error, 1: warning,
2: info)
required: false
@@ -74,7 +74,7 @@ inputs:
type: int
checkout:
- description: >
+ description: |
Whether to clone the repository in the CI/CD machine. Default value is
``true``.
default: true
diff --git a/release-github/action.yml b/release-github/action.yml
index 473126c21..47bf49267 100644
--- a/release-github/action.yml
+++ b/release-github/action.yml
@@ -23,7 +23,7 @@
name: >
Release to GitHub action
-description: >
+description: |
Release library artifacts to the GitHub release section. Some minimum
artifacts are required before running this action. These artifacts include
``documentation-html``, ``documentation-pdf``, and
@@ -35,7 +35,7 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library to be published.
required: true
type: string
@@ -43,7 +43,7 @@ inputs:
# Optional inputs
additional-artifacts:
- description: >
+ description: |
String containing a list of additional artifacts to be included in the
GitHub release.
required: false
@@ -51,7 +51,7 @@ inputs:
type: string
dry-run:
- description: >
+ description: |
Whether to run or not this action in testing mode. Testing mode executes
all the action steps except the releasing artifacts one. This allows
developers to verify the health of the action once integrated in their
diff --git a/release-pypi-private/action.yml b/release-pypi-private/action.yml
index 1d609d5f7..6d605ab5c 100644
--- a/release-pypi-private/action.yml
+++ b/release-pypi-private/action.yml
@@ -23,7 +23,7 @@
name: >
Release to PyPI private index action
-description: >
+description: |
Release library artifacts to the PyAnsys private index. Use the
``PYANSYS_PRIVATE_PYPI_TOKEN`` as the token. Artifacts get downloaded from the
CI/CD pipeline and are assumed to be named ``-artifacts``. This
@@ -35,7 +35,7 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library to be published.
required: true
type: string
@@ -43,14 +43,14 @@ inputs:
# Optional inputs
twine-username:
- description: >
+ description: |
User name used when uploading to the PyAnsys private index.
required: false
default: '__token__'
type: string
twine-token:
- description: >
+ description: |
Password used when uploading to the PyAnsys private index.
required: false
default: ''
@@ -73,7 +73,7 @@ inputs:
type: boolean
dry-run:
- description: >
+ description: |
Whether to run or not this action in testing mode. Testing mode executes
all the action steps except the releasing artifacts one. This allows
developers to verify the health of the action once integrated in their
@@ -84,7 +84,7 @@ inputs:
type: boolean
skip-existing:
- description: >
+ description: |
Continue uploading files if one already exists. Only valid when uploading
to PyPI. Other implementations may not support this.
required: false
@@ -92,7 +92,7 @@ inputs:
type: boolean
python-version:
- description: >
+ description: |
Python version for installing and using `twine
`_.
required: false
@@ -100,7 +100,7 @@ inputs:
type: string
index-name:
- description: >
+ description: |
The name of the index endpoint used for uploading the artifacts.
required: true
default: "https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/upload"
diff --git a/release-pypi-public/action.yml b/release-pypi-public/action.yml
index 0d57e6004..9255face7 100644
--- a/release-pypi-public/action.yml
+++ b/release-pypi-public/action.yml
@@ -23,7 +23,7 @@
name: >
Release to PyPI public index action
-description: >
+description: |
Release library artifacts to the PyPI public index. Use the ``PYPI_TOKEN`` as
the token. Artifacts get downloaded from the CI/CD pipeline and are assumed to be
named ``-artifacts``. This file is expected to contain a wheel file
@@ -34,7 +34,7 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library to be published.
required: true
type: string
@@ -42,14 +42,14 @@ inputs:
# Optional inputs
twine-username:
- description: >
+ description: |
User name used when uploading to the public PyPI index.
required: false
default: '__token__'
type: string
twine-token:
- description: >
+ description: |
Password used when uploading to the public PyPI index.
required: false
default: ''
@@ -73,7 +73,7 @@ inputs:
type: boolean
dry-run:
- description: >
+ description: |
Whether to run or not this action in testing mode. Testing mode executes
all the action steps except the releasing artifacts one. This allows
developers to verify the health of the action once integrated in their
@@ -84,7 +84,7 @@ inputs:
type: boolean
skip-existing:
- description: >
+ description: |
Continue uploading files if one already exists. Only valid when uploading
to PyPI. Other implementations may not support this.
required: false
@@ -92,7 +92,7 @@ inputs:
type: boolean
python-version:
- description: >
+ description: |
Python version for installing and using `twine
`_.
required: false
diff --git a/release-pypi-test/action.yml b/release-pypi-test/action.yml
index fe4d90e9f..fa9404049 100644
--- a/release-pypi-test/action.yml
+++ b/release-pypi-test/action.yml
@@ -23,7 +23,7 @@
name: >
Release to Test PyPI public index
-description: >
+description: |
Release library artifacts to the Test PyPI public index. Use the
``PYANSYS_PYPI_TEST_PAT`` as the token. Artifacts get downloaded from the
CI/CD pipeline and are assumed to be named ``-artifacts``. This
@@ -35,7 +35,7 @@ inputs:
# Required inputs
library-name:
- description: >
+ description: |
Name of the Python library to be published.
required: true
type: string
@@ -43,14 +43,14 @@ inputs:
# Optional inputs
twine-username:
- description: >
+ description: |
User name used when uploading to the public Test PyPI index.
required: false
default: '__token__'
type: string
twine-token:
- description: >
+ description: |
Password used when uploading to the public Test PyPI index.
required: false
default: ''
@@ -73,7 +73,7 @@ inputs:
type: boolean
dry-run:
- description: >
+ description: |
Whether to run or not this action in testing mode. Testing mode executes
all the action steps except the releasing artifacts one. This allows
developers to verify the health of the action once integrated in their
@@ -84,7 +84,7 @@ inputs:
type: boolean
python-version:
- description: >
+ description: |
Python version for installing and using `twine
`_.
required: false
@@ -92,7 +92,7 @@ inputs:
type: string
skip-existing:
- description: >
+ description: |
Continue uploading files if one already exists. Only valid when uploading
to PyPI. Other implementations may not support this.
required: false
diff --git a/tests-pytest/action.yml b/tests-pytest/action.yml
index 5c734416c..d9681fbaf 100644
--- a/tests-pytest/action.yml
+++ b/tests-pytest/action.yml
@@ -23,21 +23,21 @@
name: >
Tests pytest action
-description: >
+description: |
Run a test suite using `pytest `_.
inputs:
# Optional inputs
python-version:
- description: >
+ description: |
Python version used for installing and running ``pytest``.
default: '3.10'
required: false
type: string
use-python-cache:
- description: >
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.
@@ -46,7 +46,7 @@ inputs:
type: boolean
pytest-markers:
- description: >
+ description: |
Set of `pytest markers
`_ in the form of
a string. These markers are used to discretize tests when running the test
@@ -56,20 +56,20 @@ inputs:
type: string
pytest-extra-args:
- description: >
+ description: |
Set of additional ``pytest`` arguments in the form of a string.
default: ''
required: false
pytest-postargs:
- description: >
+ description: |
Directory of the test suite and the level of verbosity.
default: 'tests -vv'
required: false
type: string
requires-xvfb:
- description: >
+ description: |
Whether to install `X Virtual Frame Buffer (XVFB)
`_ and run
the whole test session using XVFB. The default value is ``false``.
@@ -78,7 +78,7 @@ inputs:
type: boolean
checkout:
- description: >
+ description: |
Whether to clone the repository in the CI/CD machine. Default value is
``true``.
default: true
@@ -86,7 +86,7 @@ inputs:
type: boolean
skip-install:
- description: >
+ description: |
Skip installation process. This should be set to `false` when using poetry
as the build-backend because it should be false with poetry as build-backend.
The default value is ``false``.
From 380e5d4ba21e5d7f72efcf3f82ecd016227d8284 Mon Sep 17 00:00:00 2001
From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Date: Wed, 7 Aug 2024 09:08:04 +0200
Subject: [PATCH 3/4] fix: also changing for name description
---
_doc-build-linux/action.yml | 2 +-
_doc-build-windows/action.yml | 2 +-
_doc-gen-canonical/action.yml | 2 +-
_doc-gen-robots/action.yml | 2 +-
_doc-gen-sitemap/action.yml | 2 +-
_doc-gen-versions-page/action.yml | 2 +-
_logging/action.yml | 2 +-
_release-pypi/action.yml | 2 +-
branch-name-style/action.yml | 2 +-
build-ci-wheels/action.yml | 2 +-
build-library/action.yml | 2 +-
build-wheelhouse/action.yml | 2 +-
check-licenses/action.yml | 2 +-
check-vulnerabilities/action.yml | 2 +-
code-style/action.yml | 2 +-
commit-style/action.yml | 2 +-
doc-build/action.yml | 2 +-
doc-changelog/action.yml | 2 +-
doc-deploy-changelog/action.yml | 2 +-
doc-deploy-dev/action.yml | 2 +-
doc-deploy-index/action.yml | 2 +-
doc-deploy-stable/action.yml | 2 +-
doc-style/action.yml | 2 +-
docker-style/action.yml | 2 +-
release-github/action.yml | 2 +-
release-pypi-private/action.yml | 2 +-
release-pypi-public/action.yml | 2 +-
release-pypi-test/action.yml | 2 +-
tests-pytest/action.yml | 2 +-
29 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/_doc-build-linux/action.yml b/_doc-build-linux/action.yml
index e1ef19d09..b6ff3343b 100644
--- a/_doc-build-linux/action.yml
+++ b/_doc-build-linux/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation build action
description: |
diff --git a/_doc-build-windows/action.yml b/_doc-build-windows/action.yml
index 0f182fad0..ef9eeb86f 100644
--- a/_doc-build-windows/action.yml
+++ b/_doc-build-windows/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation build action (Windows)
description: |
diff --git a/_doc-gen-canonical/action.yml b/_doc-gen-canonical/action.yml
index 3f6f57cce..1536839a0 100644
--- a/_doc-gen-canonical/action.yml
+++ b/_doc-gen-canonical/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Include and update canonical link tags in HTML pages of documentation.
description: |
diff --git a/_doc-gen-robots/action.yml b/_doc-gen-robots/action.yml
index 23b508165..1894c1fa3 100644
--- a/_doc-gen-robots/action.yml
+++ b/_doc-gen-robots/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Generate a robots.txt file for a website.
description: |
diff --git a/_doc-gen-sitemap/action.yml b/_doc-gen-sitemap/action.yml
index b323c2091..921b5d85b 100644
--- a/_doc-gen-sitemap/action.yml
+++ b/_doc-gen-sitemap/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation sitemap generator
description: |
diff --git a/_doc-gen-versions-page/action.yml b/_doc-gen-versions-page/action.yml
index a78b3bffe..c90637eeb 100644
--- a/_doc-gen-versions-page/action.yml
+++ b/_doc-gen-versions-page/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation generator for the versions page
description: |
diff --git a/_logging/action.yml b/_logging/action.yml
index 488b0dc48..d976f4687 100644
--- a/_logging/action.yml
+++ b/_logging/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Utils logging action
description: |
diff --git a/_release-pypi/action.yml b/_release-pypi/action.yml
index 936b5fc09..bc47068f8 100644
--- a/_release-pypi/action.yml
+++ b/_release-pypi/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Release PyPI action
description: |
diff --git a/branch-name-style/action.yml b/branch-name-style/action.yml
index 63b4e7479..c751770b2 100644
--- a/branch-name-style/action.yml
+++ b/branch-name-style/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Branch name style
description: |
diff --git a/build-ci-wheels/action.yml b/build-ci-wheels/action.yml
index 5ef7978c7..70c1cc104 100644
--- a/build-ci-wheels/action.yml
+++ b/build-ci-wheels/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Build CI wheels
description: |
diff --git a/build-library/action.yml b/build-library/action.yml
index 5a8a17c95..5d18eafa5 100644
--- a/build-library/action.yml
+++ b/build-library/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Build library action
description: |
diff --git a/build-wheelhouse/action.yml b/build-wheelhouse/action.yml
index 208e9d7e1..f7ffb07a4 100644
--- a/build-wheelhouse/action.yml
+++ b/build-wheelhouse/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Build wheelhouse action
description: |
diff --git a/check-licenses/action.yml b/check-licenses/action.yml
index 46e1a234a..55fcca169 100644
--- a/check-licenses/action.yml
+++ b/check-licenses/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Check licenses action
description: |
diff --git a/check-vulnerabilities/action.yml b/check-vulnerabilities/action.yml
index d5e64ba92..b4a00b406 100644
--- a/check-vulnerabilities/action.yml
+++ b/check-vulnerabilities/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
"Check library and third-party vulnerabilities."
description: |
diff --git a/code-style/action.yml b/code-style/action.yml
index aa4f64f98..ed1f0fe52 100644
--- a/code-style/action.yml
+++ b/code-style/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Code style
description: |
diff --git a/commit-style/action.yml b/commit-style/action.yml
index ed2201a29..8d4cd6264 100644
--- a/commit-style/action.yml
+++ b/commit-style/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Commit style
description: |
diff --git a/doc-build/action.yml b/doc-build/action.yml
index 170bfe689..d09694a6b 100644
--- a/doc-build/action.yml
+++ b/doc-build/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation build action
description: |
diff --git a/doc-changelog/action.yml b/doc-changelog/action.yml
index 8d2c71b22..da0879025 100644
--- a/doc-changelog/action.yml
+++ b/doc-changelog/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation Changelog
description: |
diff --git a/doc-deploy-changelog/action.yml b/doc-deploy-changelog/action.yml
index b0d1066fe..7c7862ece 100644
--- a/doc-deploy-changelog/action.yml
+++ b/doc-deploy-changelog/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Build CHANGELOG from towncrier fragment files
description: |
diff --git a/doc-deploy-dev/action.yml b/doc-deploy-dev/action.yml
index 10ce007c0..c1cfa3b9e 100644
--- a/doc-deploy-dev/action.yml
+++ b/doc-deploy-dev/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Doc deploy dev action
description: |
diff --git a/doc-deploy-index/action.yml b/doc-deploy-index/action.yml
index 685e632bc..e7bd22101 100644
--- a/doc-deploy-index/action.yml
+++ b/doc-deploy-index/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Doc deploy index action
description: |
diff --git a/doc-deploy-stable/action.yml b/doc-deploy-stable/action.yml
index 60a41f35b..f739435aa 100644
--- a/doc-deploy-stable/action.yml
+++ b/doc-deploy-stable/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Doc deploy stable action
description: |
diff --git a/doc-style/action.yml b/doc-style/action.yml
index e4c5fb0c9..aa34dfecf 100644
--- a/doc-style/action.yml
+++ b/doc-style/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Documentation style
description: |
diff --git a/docker-style/action.yml b/docker-style/action.yml
index 0f0b0d7dc..16b27a30d 100644
--- a/docker-style/action.yml
+++ b/docker-style/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Lint Dockerfile
description: |
diff --git a/release-github/action.yml b/release-github/action.yml
index 47bf49267..9df540822 100644
--- a/release-github/action.yml
+++ b/release-github/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Release to GitHub action
description: |
diff --git a/release-pypi-private/action.yml b/release-pypi-private/action.yml
index 6d605ab5c..043fb7349 100644
--- a/release-pypi-private/action.yml
+++ b/release-pypi-private/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Release to PyPI private index action
description: |
diff --git a/release-pypi-public/action.yml b/release-pypi-public/action.yml
index 9255face7..02aa6cdb2 100644
--- a/release-pypi-public/action.yml
+++ b/release-pypi-public/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Release to PyPI public index action
description: |
diff --git a/release-pypi-test/action.yml b/release-pypi-test/action.yml
index fa9404049..3e91e269b 100644
--- a/release-pypi-test/action.yml
+++ b/release-pypi-test/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Release to Test PyPI public index
description: |
diff --git a/tests-pytest/action.yml b/tests-pytest/action.yml
index d9681fbaf..42c2b8dbe 100644
--- a/tests-pytest/action.yml
+++ b/tests-pytest/action.yml
@@ -20,7 +20,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-name: >
+name: |
Tests pytest action
description: |
From fc736cd0fdd3878315018b9af5d747cffdffa49f Mon Sep 17 00:00:00 2001
From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Date: Wed, 7 Aug 2024 09:18:52 +0200
Subject: [PATCH 4/4] fix: typo
---
doc-deploy-changelog/action.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc-deploy-changelog/action.yml b/doc-deploy-changelog/action.yml
index 7c7862ece..31ff757d4 100644
--- a/doc-deploy-changelog/action.yml
+++ b/doc-deploy-changelog/action.yml
@@ -65,7 +65,7 @@ inputs:
type: string
use-python-cache:
- description:
+ description: |
Whether to use the Python cache for installing previously downloaded
libraries. If ``true``, previously downloaded libraries are installed from the
Python cache. If ``false``, libraries are downloaded from the PyPI index.