github / github/platform-samples
Environment variables GITHUB_APP_ID & GITHUB_APP_PRIVATE_KEY
- 主要语言
- Shell
- 星标
- 2.2k
- 派生
- 1.9k
- 平均合并
- 7 天 19 小时
- 30 天内合并 PR
- 1
描述
## 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.
贡献指南
调研方向
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.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- ruby
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100