From c1d4b40b41e59497099424c2f75af14c31886d7d Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Tue, 24 Mar 2026 16:24:02 +0000 Subject: [PATCH] docs: update actions and workflows documentation [skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- actions/deploy/jekyll/README.md | 38 +++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/actions/deploy/jekyll/README.md b/actions/deploy/jekyll/README.md index 97ca526..af3ee69 100644 --- a/actions/deploy/jekyll/README.md +++ b/actions/deploy/jekyll/README.md @@ -46,13 +46,15 @@ Main steps performed by this action: ## Usage ````yaml -- uses: hoverkraft-tech/ci-github-publish/actions/deploy/jekyll@642cdb54493d05debdc1394f4bfd7365f82e7bf1 # 0.18.2 +- uses: hoverkraft-tech/ci-github-publish/actions/deploy/jekyll@5ff7d4c3910971ed53834becd5967271b4e228cf # 0.21.1 with: # The Jekyll theme to use for the site. # Default: `jekyll-theme-cayman` theme: jekyll-theme-cayman - # The Jekyll pages path to build. Supports glob patterns and multiple paths (one per line). Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files. + # The Jekyll pages path to build. + # Supports glob patterns and multiple paths (one per line). + # Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files. # # ```yml # pages: | @@ -62,7 +64,8 @@ Main steps performed by this action: # ``` pages: "" - # Additional files to copy into the generated `assets/` directory. Supports glob patterns and multiple paths (one per line). + # Additional files to copy into the generated `assets/` directory. + # Supports glob patterns and multiple paths (one per line). # # ```yml # assets: | @@ -90,18 +93,21 @@ Main steps performed by this action: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- | -| **`theme`** | The Jekyll theme to use for the site. | **false** | `jekyll-theme-cayman` | -| **`pages`** | The Jekyll pages path to build. Supports glob patterns and multiple paths (one per line). Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files. | **false** | - | -| | | | | -| |
pages: \|
 docs/\*\*/\*.md
 .github/workflows/\*.md
 actions/\*/README.md
| | | -| **`assets`** | Additional files to copy into the generated `assets/` directory. Supports glob patterns and multiple paths (one per line). | **false** | - | -| | | | | -| |
assets: \|
 css/\*\*
 images/\*\*
 media/\*\*/\*.png
| | | -| **`site-path`** | The working directory where the prepared Jekyll site is written. Relative to the workspace. | **false** | `_site` | -| | Defaults to `_site`. | | | -| **`build-path`** | The destination directory for the built site assets. Relative to the workspace. Defaults to `build` when not set. | **false** | `build` | +| **Input** | **Description** | **Required** | **Default** | +| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | --------------------- | +| **`theme`** | The Jekyll theme to use for the site. | **false** | `jekyll-theme-cayman` | +| **`pages`** | The Jekyll pages path to build. | **false** | - | +| | Supports glob patterns and multiple paths (one per line). | | | +| | Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files. | | | +| | | | | +| |
pages: \|
 docs/\*\*/\*.md
 .github/workflows/\*.md
 actions/\*/README.md
| | | +| **`assets`** | Additional files to copy into the generated `assets/` directory. | **false** | - | +| | Supports glob patterns and multiple paths (one per line). | | | +| | | | | +| |
assets: \|
 css/\*\*
 images/\*\*
 media/\*\*/\*.png
| | | +| **`site-path`** | The working directory where the prepared Jekyll site is written. Relative to the workspace. | **false** | `_site` | +| | Defaults to `_site`. | | | +| **`build-path`** | The destination directory for the built site assets. Relative to the workspace. Defaults to `build` when not set. | **false** | `build` | @@ -140,7 +146,7 @@ This project is licensed under the MIT License. SPDX-License-Identifier: MIT -Copyright © 2025 hoverkraft +Copyright © 2026 hoverkraft For more details, see the [license](http://choosealicense.com/licenses/mit/).