Skip to content

Fix .env examples for PRIVATE_KEY -> GITHUB_PRIVATE_KEY variables#4305

Merged
hubwriter merged 2 commits intogithub:mainfrom
schlagelk:patch-1
Mar 15, 2021
Merged

Fix .env examples for PRIVATE_KEY -> GITHUB_PRIVATE_KEY variables#4305
hubwriter merged 2 commits intogithub:mainfrom
schlagelk:patch-1

Conversation

@schlagelk
Copy link
Copy Markdown
Contributor

@schlagelk schlagelk commented Mar 5, 2021

Why:

This fixes naming for a couple of variables in the .env examples in this document. Currently there are examples which suggest naming the private key variable PRIVATE_KEY, when really it should be GITHUB_PRIVATE_KEY. When following along in the example and attempting to run the server, using the incorrect name in the .env file leads to an error.

Closes [https://github.com//issues/4304]

What's being changed:

PRIVATE_KEY -> GITHUB_PRIVATE_KEY

Check off the following:

This fixes naming for a couple of variables in the `.env` examples in this document.  Currently there are examples which suggest naming the private key variable `PRIVATE_KEY`, when really it should be `GITHUB_PRIVATE_KEY`.  When following along in the example and attempting to run the server, using the incorrect name in the `.env` file leads to an error.
@welcome
Copy link
Copy Markdown

welcome Bot commented Mar 5, 2021

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.

@janiceilene
Copy link
Copy Markdown
Contributor

Thanks so much for opening an issue and a PR for this change @schlagelk! I'll get this triaged for review ⚡

@janiceilene janiceilene added github apps Content related to GitHub Apps waiting for review Issue/PR is waiting for a writer's review labels Mar 5, 2021
Copy link
Copy Markdown
Contributor

@hubwriter hubwriter left a comment

Choose a reason for hiding this comment

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

@schlagelk - Thanks so much for correcting this. I hope this error didn't inconvenience you too much when you ran up against it. Very good of you to take time to correct it. Much appreciated. 👍

Thanks again. I'll merge this to get this correction live.

@hubwriter hubwriter enabled auto-merge (squash) March 15, 2021 15:23
@hubwriter hubwriter merged commit 79fbdeb into github:main Mar 15, 2021
@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github apps Content related to GitHub Apps 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.

Incorrect Variable Naming in Examples - PRIVATE_KEY -> GITHUB_PRIVATE_KEY Leads to Error

3 participants