Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.46 KB

Get-ActionInput.md

File metadata and controls

56 lines (37 loc) · 1.46 KB
Raw

Get-ActionInput


NAME
    Get-ActionInput
    
SYNOPSIS
    Gets the value of an input. The value is also trimmed.
    Equivalent of `core.getInput(name)`.
    
    
SYNTAX
    Get-ActionInput [-Name] <String> [-Required] [<CommonParameters>]
    
    
DESCRIPTION
    

PARAMETERS
    -Name <String>
        Name of the input to get
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Required [<SwitchParameter>]
        Whether the input is required. If required and not present, will throw.
        
        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). 
    
INPUTS
    
OUTPUTS
    System.String
    
    
    
RELATED LINKS
    https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#masking-a-value-in-log
    https://github.com/actions/toolkit/tree/master/packages/core#inputsoutputs