Skip to content

Fix syntax GitHub Actions OIDC example JWT #23200

Merged
lucascosti merged 2 commits intogithub:mainfrom
timmeinerzhagen:patch-1
Jan 23, 2023
Merged

Fix syntax GitHub Actions OIDC example JWT #23200
lucascosti merged 2 commits intogithub:mainfrom
timmeinerzhagen:patch-1

Conversation

@timmeinerzhagen
Copy link
Copy Markdown
Contributor

@timmeinerzhagen timmeinerzhagen commented Jan 13, 2023

Why:

Current example JSON is not valid as string is not marked via "

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

Fix JSON entry repository_visiblity

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

@github-actions
Copy link
Copy Markdown
Contributor

👋 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*
lib/graphql/**
lib/redirects/**
lib/rest/**
lib/webhooks/**
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. :octocat:

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jan 13, 2023
@timmeinerzhagen
Copy link
Copy Markdown
Contributor Author

Are there any resources on who to reach out to regarding changes for files under content/actions/deployment/security-hardening-your-deployments/**?

Why is there a blanked deny for specifically that content? Did not find any mention / explanation in the docs or Contributing file.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 13, 2023

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.7 3.6 3.5
fpt
ghec
ghes@ 3.7 3.6 3.5

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

@cmwilson21
Copy link
Copy Markdown
Contributor

@timmeinerzhagen Thanks for opening a PR! ✨

The actions-bot gives us a bit more added precautions and security, but I'll still raise this and get it triaged for review! ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jan 13, 2023
@github-actions
Copy link
Copy Markdown
Contributor

👋 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*
lib/graphql/**
lib/redirects/**
lib/rest/**
lib/webhooks/**
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. :octocat:

Copy link
Copy Markdown
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this fix, @timmeinerzhagen! Definitely a typo 🙇‍♂️

Edit: At the moment, we normally can't accept most open source contributions to the OIDC docs because they are highly security sensitive and all content has been vetted for security impacts. Because we are a small docs team, we don't have the bandwidth to evaluate and verify the correctness of most suggestions to these specific docs.

In this case, a basic typo is fine 🙂

@lucascosti lucascosti merged commit 62abcb8 into github:main Jan 23, 2023
@github-actions
Copy link
Copy Markdown
Contributor

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

@timmeinerzhagen timmeinerzhagen deleted the patch-1 branch January 23, 2023 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants