Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: changelog actions docs missing #533

Merged
merged 4 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions _doc-build-linux/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -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
Expand All @@ -75,29 +75,29 @@ 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.
required: true
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.
required: true
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
Expand Down
16 changes: 8 additions & 8 deletions _doc-build-windows/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -43,7 +43,7 @@ inputs:
# Required inputs

sphinxopts:
description: >
description: |
Set of options to pass to the ``Sphinx`` builder.

.. note::
Expand All @@ -54,42 +54,42 @@ 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.
required: true
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.
required: true
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
Expand Down
6 changes: 3 additions & 3 deletions _doc-gen-canonical/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions _doc-gen-robots/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -34,7 +34,7 @@ inputs:
# Required inputs

cname:
description: >
description: |
The canonical name (CNAME) containing the documentation.
required: true
type: string
Expand Down
6 changes: 3 additions & 3 deletions _doc-gen-sitemap/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions _doc-gen-versions-page/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions _logging/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

name: >
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
Expand All @@ -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
Expand Down
20 changes: 10 additions & 10 deletions _release-pypi/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

name: >
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
Expand All @@ -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
<https://twine.readthedocs.io/en/stable/>`_.
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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion branch-name-style/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
14 changes: 7 additions & 7 deletions build-ci-wheels/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -40,43 +40,43 @@ 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.
required: true
type: string

operating-system:
description: >
description: |
Name of the operating system where the library is installed.
required: true
type: string

# 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
<https://www.pypy.org/>`_ in addition to the wheel files for CPython.
Default value is ``false``.
Expand Down
Loading
Loading