Skip to content

Commit ab76971

Browse files
Merge branch 'main' into DOCSS-1842-automatic-step-reruns
2 parents 35b4225 + 72f839f commit ab76971

File tree

14 files changed

+370
-174
lines changed

14 files changed

+370
-174
lines changed
594 KB
Loading
1.02 MB
Loading
312 KB
Loading
789 KB
Loading
618 KB
Loading
621 KB
Loading

docs/guides/modules/ROOT/partials/pipelines-and-triggers/pipeline-values.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,13 @@ a| * GitLab: push, merge request
421421
| image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
422422
| image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
423423

424+
| `pipeline.event.github.pull_request.merged`
425+
| GitHub App
426+
| Boolean
427+
| A boolean value indicating whether the pull request is has been merged. Only populated for pipelines triggered xref:guides:orchestrate:github-trigger-event-options.adoc#supported-trigger-options[by pull request events] (`pipeline.event.name = "pull_request"`).
428+
| image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
429+
| image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
430+
424431
| `pipeline.deploy.component_name`
425432
| GitHub App
426433
| String

docs/guides/modules/getting-started/pages/introduction-to-yaml-configurations.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -209,32 +209,32 @@ Anchors and aliases work for scalar values, but to save maps or sequences, use `
209209
210210
```yaml
211211
default: &default
212-
school: hogwarts
212+
category: Tea
213213
214-
harry:
214+
hojicha:
215215
<<: *default
216-
house: gryffindor
216+
price: 3.95
217217
218-
draco:
218+
matcha_latte:
219219
<<: *default
220-
house: slytherin
220+
price: 5.95
221221
```
222222
223223
You can also merge multiple maps.
224224
225225
```yaml
226-
name: &harry_name
227-
first_name: Harry
228-
last_name: Potter
229-
230-
address: &harry_address
231-
street: 4, Privet Drive
232-
district: Little Whinging
233-
county: Surrey
234-
country: England
235-
236-
harry_data:
237-
<<: [*harry_name, *harry_address]
226+
name: &big_bird_alter_egos
227+
ep_0246: Verybig Bird
228+
ep_3161: Big Fish
229+
230+
address: &big_bird_address
231+
street: 123½ Sesame Street
232+
city: New York
233+
state: New York
234+
country: United States
235+
236+
big_bird_data:
237+
<<: [*big_bird_alter_egos, *big_bird_address]
238238
```
239239
240240
**Note**: As mentioned in https://github.com/yaml/yaml/issues/35[a YAML repository issue], it is possible to merge maps, but not sequences (also called arrays or lists). For a more complex example, see https://gist.github.com/bowsersenior/979804[this gist].

docs/guides/modules/orchestrate/pages/github-trigger-event-options.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ workflows:
113113

114114
* `pipeline.event.github.pull_request.title`: the title of the pull request.
115115
* `pipeline.event.github.pull_request.number`: the numeric identifier of the pull request.
116+
* `pipeline.event.github.pull_request.merged`: a boolean that indicates whether the PR was merged or not.
116117

117118
These values are extracted directly from the GitHub event payload. The part after prefix `pipeline.event.github.*` matches the corresponding field in the pull request event structure described in link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[the GitHub docs].
118119

docs/guides/modules/permissions-authentication/pages/sso-overview.adoc

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,25 @@ Using SSO for authentication can result in improved security and user experience
3232
* Adding and deleting users.
3333
* Managing user permissions.
3434

35-
**For a member of an organization using SSO for authentication:** The process of authentication to access applications is simplified. Rather than authenticating separately for each application, SAML SSO enables the user to confirm their identity _once_ with an IdP and that authentication is communicated to the applications (such as CircleCI) that the user has access to. The user may then access these applications for the duration of their session.
35+
**For a member of an organization using SSO for authentication:** The process of authentication to access applications is simplified. Rather than authenticating separately for each application, SAML SSO enables the user to confirm their identity _once_ with an IdP. This authentication is then communicated to all applications (such as CircleCI) that the user has access to. The user may then access these applications for the duration of their session.
36+
37+
== Personal API tokens with SSO
38+
39+
When your organization uses SSO, Personal API tokens require SSO authentication to access your organization's resources.
40+
41+
To use Personal API tokens with SSO-protected resources:
42+
43+
. Go to the link:https://app.circleci.com/home/[CircleCI web app].
44+
. Select your profile from the upper right corner, then select menu:User Settings[].
45+
. Select menu:Personal API Tokens[] from the sidebar.
46+
. For each token you want to use with your SSO-enabled organization, select the organization from the dropdown in the SSO column.
47+
. Once you select an organization, the token becomes SSO-authenticated and can access your organization's resources.
48+
49+
**Important notes:**
50+
51+
* The SSO authentication option for tokens is only available when you are actively signed in via SSO.
52+
* SSO authentication is only required for tokens you intend to use with SSO-enabled organization resources.
53+
* Tokens without SSO authentication still work with non-SSO protected resources.
3654

3755
[#prerequisites-and-limitations]
3856
== Limitations
@@ -42,11 +60,6 @@ SSO for CircleCI currently has the following limitations:
4260
* SSO requires all users to log into CircleCI either with an email and password or using social logins like GitHub, Bitbucket prior to the SSO login. The email used to log in to CircleCI does *not* need to match the email used to authenticate with the IdP.
4361
* CircleCI supports SSO using one domain per organization.
4462
* When the user logs in using social logins like GitHub or Bitbucket, then they need to authorize SSO in the VCS org along with SSO setup in CircleCI.
45-
* Personal API tokens will not work against your organization after SSO is enabled. As a result **the following features are unavailable when using SSO**:
46-
** The CircleCI VS Code plugin will **not** work against your organization after SSO is enabled.
47-
** The CircleCI CLI will **not** work against your organization after SSO is enabled.
48-
** API v2 endpoints will **not** be accessible for your organization after SSO is enabled.
49-
** Config policies will **not** be usable/enforcable for your organization after SSO is enabled.
5063

5164

5265
[#next-steps]

0 commit comments

Comments
 (0)