actions / actions/runner

Allow properties in action.yml that are prefixed with an underscore

Open
#1,700 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
6.3k
Forks
1.4k
Avg merge
1d 16h
Merged PRs (30d)
24

Description

Describe the enhancement

I'm trying to automate creating documentation so in my action.yml I put a property on each outputs called example. This was then used to build the table seen here https://github.com/xt0rted/dotnet-sdk-updater#outputs.

The problem with this is the runner detects non-standard property names, logs an error for each of them, and then fails the run. To work around this I have a script that comments out the example lines before committing the release.

I'm wondering if it'd be possible to add an example property to outputs or better yet update the runner to allow properties prefixed with an underscore that way they can be used for other purposes.

Code Snippet

Additional information

My action.yml with additional properties https://github.com/xt0rted/dotnet-sdk-updater/blob/main/action.yml

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the referenced action.yml and the update-readme.ts documentation automation first to understand the extra output property and its intended use. Trace the runner's action metadata validation, then confirm that underscore-prefixed properties are accepted without errors while standard output handling remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
ci-cd, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.