github / github/platform-samples

Environment variables GITHUB_APP_ID & GITHUB_APP_PRIVATE_KEY

Ouverte
#214 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Shell
Étoiles
2.2k
Forks
1.9k
Merge moyen
7 j 19 h
PR mergées (30 j)
1

Description

## Issue
I am doing the [building your first github app guide](https://developer.github.com/apps/building-your-first-github-app/), and in documentation at section [runtime environment](https://developer.github.com/apps/building-your-first-github-app/#prepare-the-runtime-environment) the variables have different naming than in code.

### Vars on Guide

export GITHUB_APP_IDENTIFIER=12345
export GITHUB_PRIVATE_KEY= ...
### Vars on Code
```
begin
GITHUB_APP_ID = ENV.fetch("GITHUB_APP_ID")
GITHUB_PRIVATE_KEY = ENV.fetch("GITHUB_APP_PRIVATE_KEY")
rescue KeyError
$stderr.puts "To run this script, please set the following environment variables:"
$stderr.puts "- GITHUB_APP_ID: GitHub App ID"
$stderr.puts "- GITHUB_APP_PRIVATE_KEY: GitHub App Private Key"
exit 1
end
```
## Solution

Decide if the docs have to be changed or the code, if the code has to be changed I will be pleased to make a pull request to fix this.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start by comparing the guide's “Prepare the runtime environment” section with the Ruby code snippet and its environment-variable error messages. Decide which names are authoritative, then make the guide and code consistent and verify that the documented variables match those required when the sample runs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
ruby
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.