* 🔒 Document how to use secrets with `if:`
github/docs#6861github/docs#12722
- Add a complete workflow example to `jobs.<job_id>.steps[*].if`,
demonstrating how to skip a step if a secret is not present
- Add an explanation to "Using encrypted secrets in a workflow"
- Cross-reference the two pages
* 🔒 Compare secrets with empty strings in `if:`
github/docs#6861https://github.com/github/docs/pull/12722#discussion_r801011000
Rather than referencing two secrets:
1. `${{ secrets.SECRET_IS_SET }}`
2. `${{ secrets.SECRET_IS_NOT_SET }}`)
This commit will update the related section of the docs to reference a
single secret (`${{ secrets.SECRET_IS_SET }}`), and will update the
`if:` conditionals to compare with empty strings as suggested.
* 🔒 Add missing `{% raw %}`/`{% endraw %}`
github/docs#6861github/docs#12722
Some `${{ }}` values were converted to `$` in the preview environment.
Adding `{% raw %}`/`{% endraw %}` will preserve the raw value.
* 🔒 Match variable and secret names in examples
github/docs#6861https://github.com/github/docs/pull/12722#discussion_r801011000
This PR adds an example of how to use secrets with `if:` conditionals.
The reviewer suggested comparing variable values with empty strings to
make the `if:` conditionals clearer.
Commit cecdf00 updated the secret names accordingly, but the names of
the secret and environment variable may still have been confusing.
This commit will update the secret and environment variable names to
match the cross-referenced example on the "Encrypted secrets" page.
* Update content/actions/using-workflows/workflow-syntax-for-github-actions.md
Co-authored-by: hubwriter <hubwriter@github.com>
* Deprecate 3.0
* 3.0 deprecation: remove 3.0 markup (#25647)
* Remove liquid conditionals and content for 3.0 deprecation
* Remove manually, no longer versioned in a supported version
* Remove translations manually, no longer versioned in a supported version
* Remove 'if', now in all supported versions
* Remove dangling 'elseif', now in all supported versions
* Remove dangling 'elseif' and 3.0 screenshot reference, now in all supported versions
* Nudge to latest supported GHES version
* Nudge to latest supported release GHES version
* Bump all the version for the liquid tests
* Bump first deprecated version for linting tests
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Prefer double quotes
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Remove extra newline
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Remove extra newline
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Remove extra newline
Co-authored-by: Laura Coursen <lecoursen@github.com>
* One reusable per line
Co-authored-by: Laura Coursen <lecoursen@github.com>
* One reusable per line
Co-authored-by: Laura Coursen <lecoursen@github.com>
* One reusable per line
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Stray whitespace ✂️
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Version check not needed anymore
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Just 'ghes' since we're deprecating 3.0
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Don't depend on hardcoded versions
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Remove static files for 3.0 deprecation (#25649)
Co-authored-by: Laura Coursen <lecoursen@github.com>
The docs currently state:
> Reusable workflows are YAML-formatted files, very similar to any other workflow file. As with other workflow files, you locate reusable workflows in the `.github/workflows` directory of a repository. Subdirectories of the `workflows` directory are not supported.
But the example yml then presents the path `uses: ./.github/actions/my-action` which doesn't follow the initial advice about location of workflow files.
Change is to use `uses: ./.github/workflows/my-action` to make example valid, but this is assuming the `Creating a reusable workflow` section is also accurate.
* Begin work on PR
* Modify intro section
* Add details of contexts
* More details added
* Fix broken link
* Fix liquid error
* More WiP
* More WiP changes
* add env var examples
* Finish initial draft of env vars article update
* Fix versioning in table
* Add remaining examples
* Another WiP tweak
* More WiP changes
* More WiP changes
* More WiP changes
* More WiP changes
* More WiP changes
* Add <nobr> to things
* Finish updating other articles
* test line breaks
* Remove previous test
* Update links to files now moved
* Rebplace nobr with spans
* Another test
* Remove the previous test
* Remove misleading note.
This note box was added by an OS contributor
https://github.com/github/docs/pull/9236/files
but is, at best, misleading.
Environment variables *can* be referenced directly within
a run command as and do *not* have to be
referenced via the SHELL=/usr/local/bin/bash
ITERM_PROFILE=Default
COLORTERM=truecolor
XPC_FLAGS=0x0
NVM_INC=/Users/alistair/.nvm/versions/node/v12.8.0/include/node
TERM_PROGRAM_VERSION=3.4.14
GIT_PS1_SHOWUPSTREAM=verbose git
__CFBundleIdentifier=com.googlecode.iterm2
SSH_AUTH_SOCK=/var/folders/bh/jrv856xx31zfmhc60chqvxqw0000gn/T//ssh-7EnftFpl4aXq/agent.77591
GIT_PS1_SHOWDIRTYSTATE=1
TERM_SESSION_ID=w2t0p0:9F68FC35-8DB9-4051-A7C6-5E61A2C37694
HOMEBREW_AUTO_UPDATE_SECS=3600
RBENV_SHELL=bash
SSH_AGENT_PID=77592
ITERM_PREV_PS1=\[]133;D;$?]133;A\]\[\033[1;36m\]\w\[\033[0m\] \[\033[1;32m\]$(__git_ps1)\[\033[0m\]
\$ \[]133;B\]
GPG_TTY=/dev/ttys002
EDITOR=vi
ITERM_ORIG_PS1=\[\033[1;36m\]\w\[\033[0m\] \[\033[1;32m\]$(__git_ps1)\[\033[0m\]
\$
PWD=/Users/alistair/git-repos/docs-internal
LOGNAME=alistair
COMMAND_MODE=unix2003
NODENV_SHELL=bash
ITERM_SESSION_ID=w2t0p0:9F68FC35-8DB9-4051-A7C6-5E61A2C37694
HOME=/Users/alistair
LANG=en_GB.UTF-8
LS_COLORS=di=1;0;42:fi=0:ln=31:pi=5:so=5:bd=5:cd=5:or=31:mi=0:ex=35;40:*.rpm=90
TMPDIR=/var/folders/bh/jrv856xx31zfmhc60chqvxqw0000gn/T/
LC_TERMINAL=iTerm2
NVM_DIR=/Users/alistair/.nvm
TOKEN=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
TERM=xterm-256color
USER=alistair
COLORFGBG=15;0
LC_TERMINAL_VERSION=3.4.14
SHLVL=0
NVM_CD_FLAGS=
XPC_SERVICE_NAME=0
PS1=\[\033[1;36m\]\w\[\033[0m\] \[\033[1;32m\]$(__git_ps1)\[\033[0m\]
\$
PATH=/Users/alistair/git-repos/awssume/bin:/Users/alistair/git-repos/awssume/bin:/Users/alistair/.gem/ruby/2.7.0/bin:/Users/alistair/.rbenv/shims:/Users/alistair/.nodenv/shims:/Users/alistair/.nvm/versions/node/v12.8.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Users/alistair/git-repos/github/bin:/Users/alistair/programming:/Applications/VMware Fusion.app/Contents/Public:/usr/local/MacGPG2/bin:/Library/Apple/usr/bin:/Users/alistair/.node/bin:/Users/alistair/.nodenv/versions/14.13.0/
NVM_BIN=/Users/alistair/.nvm/versions/node/v12.8.0/bin
OLDPWD=/Users/alistair/git-repos/docs-internal/lib
__CF_USER_TEXT_ENCODING=0x1F5:0x0:0x2
TERM_PROGRAM=iTerm.app
_=/usr/bin/env context.
Confirmed by an answer to a question in the c2c-actions
channel https://github.slack.com/archives/CDJAC532T/p1642154921002900
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/using-workflows/workflow-commands-for-github-actions.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Update content/actions/learn-github-actions/environment-variables.md
Co-authored-by: Laura Coursen <lecoursen@github.com>
* Make remaining review comment changes
Co-authored-by: Laura Coursen <lecoursen@github.com>
