Fix formatting of OpenID Connect examples #28058

afairb · 2023-09-06T19:59:39Z

Why:

There are a few small formatting issues on this page of documentation.

Closes: n/a (small copy fix only)

What's being changed (if available, include any code snippets, screenshots, or gifs):

One code sample is missing an opening ` symbol
Other code samples have mismatched " symbols

Check off the following:

I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
- For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
For content changes, I have completed the self-review checklist.

github-actions · 2023-09-06T19:59:56Z

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
.devcontainer/**
.github/actions-scripts/**
.github/workflows/**
.github/CODEOWNERS
assets/fonts/**
data/graphql/**
Dockerfile*
src/**
lib/redirects/**
package*.json
scripts/**
content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process.

github-actions · 2023-09-06T20:05:01Z

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source	Preview	Production	What Changed
`actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md`	fpt ghec ghes@ 3.10 3.9 3.8 3.7 3.6	fpt ghec ghes@ 3.10 3.9 3.8 3.7 3.6

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

cmwilson21 · 2023-09-07T14:42:28Z

@afairb Thanks so much for submitting a PR! I'll get this triaged for review ⚡

subatoi

Thank you very much for making this series of changes 👍 ✨

github-actions · 2023-09-07T15:36:41Z

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
.devcontainer/**
.github/actions-scripts/**
.github/workflows/**
.github/CODEOWNERS
assets/fonts/**
data/graphql/**
Dockerfile*
src/**
lib/redirects/**
package*.json
scripts/**
content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process.

subatoi · 2023-09-07T15:49:02Z

@afairb Apologies, I just need to confirm internally we can make an exception on this one before merging, as a matter of course, as it's one of the articles that normally requires approval from another team.

afairb · 2023-09-07T16:10:42Z

@afairb Apologies, I just need to confirm internally we can make an exception on this one before merging, as a matter of course, as it's one of the articles that normally requires approval from another team.

No problem - I didn't realise these files were in that list before raising the PR and seeing the bot comment!

N-Usha · 2023-09-12T20:36:54Z

...ployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md

@@ -290,7 +290,8 @@ After this setting is applied, the JWT will contain the updated `iss` value. In

 ### Customizing the subject claims for an organization or repository

-To help improve security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. You can use the [OIDC REST API](/rest/actions/oidc) to apply a customization template for the OIDC subject claim; for example, you can require that the `sub` claim within the OIDC token must always include a specific custom claim, such as `job_workflow_ref`.
+To help improve security, compliance, and standardization, you can customize the standard claims to suit your 


What is the change suggested here?

@N-Usha it's mainly just formatting around some of the monospaced element:

"job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"

It's got a little bit "broken" because of a newline, I think, which has obscured the relevant change in the diff.

@afairb 👋 would you mind editing this slightly or letting me know if you prefer I take a look at it? It won't matter for the render in the site but it would be ideal if we could do. Then we can get this merged!

Sorry, I hadn't spotted this earlier. Crept in by accident and removed now :)

github-actions · 2023-09-13T08:26:43Z

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
.devcontainer/**
.github/actions-scripts/**
.github/workflows/**
.github/CODEOWNERS
assets/fonts/**
data/graphql/**
Dockerfile*
src/**
lib/redirects/**
package*.json
scripts/**
content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process.

github-actions · 2023-09-13T08:28:12Z

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
.devcontainer/**
.github/actions-scripts/**
.github/workflows/**
.github/CODEOWNERS
assets/fonts/**
data/graphql/**
Dockerfile*
src/**
lib/redirects/**
package*.json
scripts/**
content/actions/deployment/security-hardening-your-deployments/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process.

subatoi

Thank you again for fixing this and for your interest in the docs! I'll go ahead and get this merged

github-actions · 2023-09-13T09:18:14Z

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Fix formatting of OpenID Connect examples

512881e

github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 6, 2023

This comment was marked as spam.

Sign in to view

subatoi previously approved these changes Sep 7, 2023

View reviewed changes

Merge branch 'main' into patch-1

573840b

N-Usha approved these changes Sep 12, 2023

View reviewed changes

Remove accidental newline

9e1db13

afairb dismissed subatoi’s stale review via 9e1db13 September 13, 2023 08:26

Merge branch 'main' into patch-1

3520bf9

subatoi approved these changes Sep 13, 2023

View reviewed changes

subatoi added this pull request to the merge queue Sep 13, 2023

Merged via the queue into github:main with commit 144c1d0 Sep 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix formatting of OpenID Connect examples #28058

Fix formatting of OpenID Connect examples #28058

Uh oh!

afairb commented Sep 6, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Sep 6, 2023

Uh oh!

github-actions bot commented Sep 6, 2023 •

edited

Loading

Uh oh!

This comment was marked as spam.

Uh oh!

cmwilson21 commented Sep 7, 2023

Uh oh!

subatoi left a comment

Uh oh!

github-actions bot commented Sep 7, 2023

Uh oh!

subatoi commented Sep 7, 2023

Uh oh!

afairb commented Sep 7, 2023

Uh oh!

N-Usha Sep 12, 2023

Uh oh!

subatoi Sep 13, 2023 •

edited

Loading

Uh oh!

afairb Sep 13, 2023

Uh oh!

github-actions bot commented Sep 13, 2023

Uh oh!

github-actions bot commented Sep 13, 2023

Uh oh!

subatoi left a comment

Uh oh!

github-actions bot commented Sep 13, 2023

Uh oh!

Uh oh!

Fix formatting of OpenID Connect examples #28058

Fix formatting of OpenID Connect examples #28058

Uh oh!

Conversation

afairb commented Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

Uh oh!

github-actions bot commented Sep 6, 2023

Uh oh!

github-actions bot commented Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automatically generated comment ℹ️

Content directory changes

Uh oh!

This comment was marked as spam.

Uh oh!

cmwilson21 commented Sep 7, 2023

Uh oh!

subatoi left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 7, 2023

Uh oh!

subatoi commented Sep 7, 2023

Uh oh!

afairb commented Sep 7, 2023

Uh oh!

N-Usha Sep 12, 2023

Choose a reason for hiding this comment

Uh oh!

subatoi Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

afairb Sep 13, 2023

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 13, 2023

Uh oh!

github-actions bot commented Sep 13, 2023

Uh oh!

subatoi left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 13, 2023

Uh oh!

Uh oh!

afairb commented Sep 6, 2023 •

edited

Loading

github-actions bot commented Sep 6, 2023 •

edited

Loading

subatoi Sep 13, 2023 •

edited

Loading