Skip to content
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.

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

github app: generate jwt with powershell #30679

Merged
merged 6 commits into from
Dec 19, 2023
Merged

Conversation

mac2000
Copy link
Contributor

@mac2000 mac2000 commented Dec 14, 2023

Why:

PowerShell is quite powerful and adopted alternative to Bash and Python, even more, it is available out of the box in GitHub Actions.

Will be so nice to have an example of how we can sign JWT token in it, so anyone will not spent time trying to figure this out in future

The good news - everything is done without the need of any 3rd party dependencies so will work everywhere

While trying to figure out how to do it, instead of making notes to my notebook decided why not to ask for such change here, right in docs

Closes: #30678

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

No changes, addition of one more example

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.

Powershell is quite powerful and adopted alternative to Bash and Python, even GitHub Actions have it out of the box, so here is an example of how we can create an JWT token using it. The beauty of this approach is that there is no external 3rd party dependencies needed.
Copy link

welcome bot commented Dec 14, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 14, 2023
Copy link
Contributor

github-actions bot commented Dec 14, 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
apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae

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

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review github apps Content related to GitHub Apps and removed triage Do not begin working on this issue until triaged by the team labels Dec 14, 2023
@nguyenalex836
Copy link
Contributor

@mac2000 Thanks so much for opening a PR! I'll get this triaged for review ✨

@mac2000
Copy link
Contributor Author

mac2000 commented Dec 14, 2023

Hm, something strange Content Lint Markdown / lint-content does not like neither pwsh nor ps1 🤷‍♂️

Copy link
Contributor

@skedwards88 skedwards88 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 adding this example! I made some suggestions to use placeholders in accordance with the style guide; I'll incorporate those suggestions and then get this merged for you.

skedwards88
skedwards88 previously approved these changes Dec 19, 2023
@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label Dec 19, 2023
@skedwards88 skedwards88 added this pull request to the merge queue Dec 19, 2023
Merged via the queue into github:main with commit 8b9d506 Dec 19, 2023
42 checks passed
Copy link
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team github apps Content related to GitHub Apps ready to merge This pull request is ready to merge 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.

Example: Using PowerShell to generate a JWT
3 participants