From e310904cc7086ffd73ca14b1abf74f9efb90ea12 Mon Sep 17 00:00:00 2001 From: Jason Nagin <33561705+JasonN3@users.noreply.github.com> Date: Wed, 8 Oct 2025 11:41:09 -0400 Subject: [PATCH] Fix documentation about iso_path (#177) --- README.md | 4 ++-- docs/_Sidebar.md | 3 ++- docs/home.md | 3 ++- docs/usage.md | 6 +++--- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 26a3de9..fdea723 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ This action is designed to be called from a GitHub workflow using the following with: name: ${{ steps.build.outputs.iso_name }} path: | - ${{ steps.build.outputs.iso_path }} - ${{ steps.build.outputs.iso_path }}-CHECKSUM + ${{ steps.build.outputs.iso_path }}/${{ steps.build.outputs.iso_name }} + ${{ steps.build.outputs.iso_path }}/${{ steps.build.outputs.iso_name }}-CHECKSUM if-no-files-found: error retention-days: 0 compression-level: 0 diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md index 300a54e..7e637e7 100644 --- a/docs/_Sidebar.md +++ b/docs/_Sidebar.md @@ -1,4 +1,5 @@ - [Home](home.md) +- [Usage](usage.md) - Development - [Using the Makefile](development/makefile.md) - [Using the Container](development/container.md) @@ -7,4 +8,4 @@ - Examples - [Adding Flatpaks](examples/adding-flatpaks.md) -- [Known Errors](known_errors.md) \ No newline at end of file +- [Known Errors](known_errors.md) diff --git a/docs/home.md b/docs/home.md index e8b6e75..f7e2096 100644 --- a/docs/home.md +++ b/docs/home.md @@ -2,6 +2,7 @@ Welcome to the build-container-installer wiki! ## Index +- [Usage](usage.md) - Development - [Using the Makefile](development/makefile.md) - [Using the Container](development/container.md) @@ -10,4 +11,4 @@ Welcome to the build-container-installer wiki! - Examples - [Adding Flatpaks](examples/adding-flatpaks.md) -- [Known Errors](known_errors.md) \ No newline at end of file +- [Known Errors](known_errors.md) diff --git a/docs/usage.md b/docs/usage.md index 9f6a83f..9ffeb8e 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -22,8 +22,8 @@ This action is designed to be called from a GitHub workflow using the following with: name: ${{ steps.build.outputs.iso_name }} path: | - ${{ steps.build.outputs.iso_path }} - ${{ steps.build.outputs.iso_path }}-CHECKSUM + ${{ steps.build.outputs.iso_path }}/${{ steps.build.outputs.iso_name }} + ${{ steps.build.outputs.iso_path }}/${{ steps.build.outputs.iso_name }}-CHECKSUM if-no-files-found: error retention-days: 0 compression-level: 0 @@ -65,4 +65,4 @@ Variant will be the third item in the package name. Example: `fedora-release-kin | Variable | Description | Usage | | -------- | ----------------------------------------| ------------------------------------------------ | | iso_name | The name of the resulting .iso | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_name }} | -| iso_path | The name and path of the resulting .iso | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_name }} | \ No newline at end of file +| iso_path | The path to the resulting .iso | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_path }} |