Skip to content

Stop-GitHubLogGroup

SYNOPSIS

Stops the current log group in GitHub Actions

SYNTAX

__AllParameterSets

Stop-GitHubLogGroup [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Ends the expandable group in the GitHub Actions log that was started with Start-GitHubLogGroup. All log output after this command will no longer be nested within the group.

This function only has an effect when running in a GitHub Actions workflow (when $env:GITHUB_ACTIONS is 'true'). When run outside of GitHub Actions, it does nothing.

This corresponds to the ::endgroup:: workflow command in GitHub Actions.

EXAMPLES

EXAMPLE 1

Stop-GitHubLogGroup

Stops the current log group in GitHub Actions.

EXAMPLE 2

Start-GitHubLogGroup 'Deployment Steps'
Write-Host 'Deploying to staging...'
Write-Host 'Deployment complete'
Stop-GitHubLogGroup
Write-Host 'This output is not in the group'

Creates a log group for deployment steps. The final Write-Host command outputs text outside of the group since Stop-GitHubLogGroup was called.

PARAMETERS

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Workflow commands