Skip to content

Update action.yml inputs and descriptions #808

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.

Sign up for GitHub

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

Closed
gewarren wants to merge 4 commits into from
Closed

Update action.yml inputs and descriptions #808

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b501c73
Update action.yml inputs and descriptions
gewarren Nov 4, 2026
7cc4ca7
Update cleanrepo/action.yml
gewarren Nov 4, 2026
922100d
Apply suggestion from @gewarren
gewarren Nov 4, 2026
14c5fad
Apply suggestion from @gewarren
gewarren Nov 4, 2026
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
7 changes: 6 additions & 1 deletion cleanrepo/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ branding:
color: 'purple'
inputs:
function:
description: 'The function you want to run: FindOrphanedArticles, FindOrphanedImages, FindOrphanedIncludes, FindOrphanedSnippets, CatalogImages, CatalogImagesWithText, FilterImagesForText, ReplaceRedirectTargets, ReplaceWithRelativeLinks, or RemoveRedirectHops.'
description: 'The function you want to run: FindOrphanedArticles, FindOrphanedImages, FindOrphanedIncludes, FindOrphanedSnippets, ReplaceRedirectTargets, ReplaceWithRelativeLinks, or RemoveRedirectHops.'
required: true
docfx_directory:
description: 'The directory that contains the docfx.json file for the docset.'
Expand All @@ -18,6 +18,9 @@ inputs:
url_base_path:
description: 'The URL base path for your docset, for example, /dotnet or /windows/uwp.'
required: true
exclude_include_files:
description: 'A list of file names or paths that should never be considered orphaned.'
default: "[]"
runs:
using: docker
image: ../cleanrepo.Dockerfile
Expand All @@ -30,3 +33,5 @@ runs:
- ${{ inputs.target_directory }}
- '/Options:UrlBasePath'
- ${{ inputs.url_base_path }}
- '/Options:ExcludeOrphanedIncludeFiles'
- ${{ fromJSON(inputs.exclude_include_files) }}
Comment thread
gewarren marked this conversation as resolved.
Resolved
Loading