Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit6070689

Browse files
committed
Include references to secret management systems
1 parent85cbfdd commit6070689

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

‎Readme.md‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#Sample GitHub App
22

3-
Minimal exampleofa GitHub App using[octokit.js](https://github.com/octokit/octokit.js).
3+
Exampleofan integration via GitHub App using[octokit.js](https://github.com/octokit/octokit.js).
44

55
##Requirements
66

@@ -9,7 +9,8 @@ Minimal example of a GitHub App using [octokit.js](https://github.com/octokit/oc
99
- Pull requests: Read & write
1010
- Metadata: Read-only
1111
- (For local development) A tunnel to expose your local server to the internet (e.g.[smee](https://smee.io/),[ngrok](https://ngrok.com/) or[cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/))
12-
12+
- Your GitHub App Webhook must be configured to receive events at a URL that is accessible from the internet.
13+
1314
##Setup
1415

1516
1. Clone this repository.
@@ -29,3 +30,14 @@ the corresponding Webhook [payload](https://docs.github.com/webhooks-and-events/
2930
The server in this example listens for`pull_request.opened` events and acts on
3031
them by creating a comment on the pull request, with the message in`message.md`,
3132
using the[octokit.js rest methods](https://github.com/octokit/octokit.js#octokitrest-endpoint-methods).
33+
34+
##Security considerations
35+
36+
To keep things simple, this example reads the`GITHUB_APP_PRIVATE_KEY` from the
37+
environment. A more secure and recommended approach is to use a secrets management system
38+
like[Vault](https://www.vaultproject.io/use-cases/key-management), or one offered
39+
by major cloud providers:
40+
[Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/secrets/quick-create-node?tabs=windows),
41+
[AWS Secrets Manager](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-secrets-manager/),
42+
[Google Secret Manager](https://cloud.google.com/nodejs/docs/reference/secret-manager/latest),
43+
etc.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp