Skip to content

Mention checkout refs in context expression restriction example #9988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gordonsyme wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Mention checkout refs in context expression restriction example #9988

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86d2b4f
Mention checkout refs in context expression restriction example
gordonsyme Feb 11, 2026
8cde086
Merge branch 'main' into gordon/update-safe-context-restriction-expre…
soulchips Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/guides/modules/security/pages/contexts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,18 +245,19 @@ You must be an *organization admin* to remove projects from contexts though the
[#expression-restrictions]
== Expression restrictions

Restrict contexts by setting up _expression restrictions_. Expression restrictions are rules that xref:orchestrate:pipeline-variables.adoc#pipeline-values[pipeline values] must match. Using expression restrictions allows you to create arbitrary constraints on the circumstances in which a context is available for use. For example, you may have a context containing credentials that should only be used for deploying your code from your protected `main` branch:
Restrict contexts by setting up _expression restrictions_. Expression restrictions are rules that xref:orchestrate:pipeline-variables.adoc#pipeline-values[pipeline values] must match. Using expression restrictions allows you to create arbitrary constraints on the circumstances in which a context is available for use. For example, you may have a context containing credentials that should only be used for deploying your code from your protected `main` branch. You also want to make sure that the config is from a protected `main` branch for any triggers that use a different checkout and config source:

[source]
----
pipeline.git.branch == "main" and not job.ssh.enabled and not (pipeline.config_source starts-with "api"")
pipeline.git.branch == "main" and pipeline.config.ref == "refs/heads/main" and not job.ssh.enabled and not (pipeline.config_source starts-with "api"")
----

Tabs and new lines are considered whitespace so can be used to break long lines, but have no other significance. For example, the snippet above could also be written:

[source]
----
pipeline.git.branch == "main"
and pipeline.config.ref == "refs/heads/main"
and not job.ssh.enabled
and not (pipeline.config_source starts-with "api")
----
Expand Down