jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

Update workflow-commands-for-github-actions.md

Browse Source
This commit is contained in:
Martin Lopes
2022-02-14 15:17:56 +10:00
parent 97265eeaf0
commit e5af39e51a
1 changed files with 36 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
content/actions/using-workflows/workflow-commands-for-github-actions.md
View File

@@ -215,15 +215,26 @@ Creates an expandable group in the log. To create a group, use the `group` comma
### Example: Grouping log lines ### Example: Grouping log lines
```bash{:copy} ```bash{:copy}
echo "::group::My title" jobs:
echo "Inside group" bash-example:
echo "::endgroup::" runs-on: ubuntu-latest
steps:
- name: Group of log lines
run: |
echo "::group::My title"
echo "Inside group"
echo "::endgroup::"
``` ```
```PowerShell{:copy} ```PowerShell{:copy}
Write-Output "::group::My title" jobs:
Write-Output "Inside group" powershell-example:
Write-Output "::endgroup::" runs-on: windows-latest
steps:
- name: Group of log lines
run: Write-Output "::group::My title"
Write-Output "Inside group"
Write-Output "::endgroup::"
``` ```
![Foldable group in workflow run log](/assets/images/actions-log-group.png) ![Foldable group in workflow run log](/assets/images/actions-log-group.png)
@@ -253,13 +264,25 @@ Write-Output "::add-mask::Mona The Octocat"
When you print the variable `MY_NAME` or the value `"Mona The Octocat"` in the log, you'll see `"***"` instead of `"Mona The Octocat"`. When you print the variable `MY_NAME` or the value `"Mona The Octocat"` in the log, you'll see `"***"` instead of `"Mona The Octocat"`.
```bash{:copy} ```bash{:copy}
MY_NAME="Mona The Octocat" jobs:
echo "::add-mask::$MY_NAME" bash-example:
runs-on: ubuntu-latest
env:
MY_NAME: "Mona The Octocat"
steps:
- name: bash-version
run: echo "::add-mask::$MY_NAME"
``` ```
```PowerShell{:copy} ```PowerShell{:copy}
$env:MY_NAME="Mona The Octocat" jobs:
Write-Output "::add-mask::$env:MY_NAME" powershell-example:
runs-on: windows-latest
env:
MY_NAME: "Mona The Octocat"
steps:
- name: powershell-version
run: Write-Output "::add-mask::$env:MY_NAME"
``` ```
## Stopping and starting workflow commands ## Stopping and starting workflow commands
@@ -306,7 +329,6 @@ jobs:
- name: disable workflow commands - name: disable workflow commands
run: | run: |
Write-Output '::warning:: this is a warning' Write-Output '::warning:: this is a warning'
# PowerShell lacks a simple function to create a hash from a string unfortunately.
$stopMarker = New-Guid $stopMarker = New-Guid
Write-Output "::stop-commands::$stopMarker" Write-Output "::stop-commands::$stopMarker"
Write-Output '::warning:: this will NOT be a warning' Write-Output '::warning:: this will NOT be a warning'
@@ -350,7 +372,7 @@ jobs:
```PowerShell{:copy} ```PowerShell{:copy}
jobs: jobs:
workflow-command-job: workflow-command-job:
runs-on: windows-2019 runs-on: windows-latest
steps: steps:
- name: toggle workflow command echoing - name: toggle workflow command echoing
run: | run: |
@@ -403,7 +425,7 @@ When using `shell: powershell`, you must specify UTF-8 encoding. For example:
```PowerShell{:copy} ```PowerShell{:copy}
jobs: jobs:
legacy-powershell-example: legacy-powershell-example:
uses: windows-2019 uses: windows-latest
steps: steps:
- shell: powershell - shell: powershell
run: "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append run: "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
@@ -414,7 +436,7 @@ Alternatively, you can use PowerShell Core (`shell: pwsh`), which defaults to UT
```PowerShell{:copy} ```PowerShell{:copy}
jobs: jobs:
legacy-powershell-example: legacy-powershell-example:
uses: windows-2019 uses: windows-latest
steps: steps:
- shell: pwsh - shell: pwsh
run: "mypath" >> $env:GITHUB_PATH run: "mypath" >> $env:GITHUB_PATH