-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Daiki Katsuragawa edited this page Aug 6, 2018
·
11 revisions
この内容はProbotの公式ドキュメント(Ⓒ Probot 2017)をもとに日本語に改変したものです.ライセンス
Probotは,TypeScriptで記述されたGitHub Appsのフレームワークです. Probotを利用することで,Webhookの受信や認証ハンドラを実装せず,GitHub Appsを開発することができます.また,Probotの開発,公開,共有は自由に行うことができ,現在も多くのアプリケーションが公開されています(公開アプリケーション: https://probot.github.io/apps/)
注意: 本ドキュメントはgitおよびGitHubや簡単なプログラミングの知識を前提としています.gitやGitHubについてはこちらを参照してください
公式ドキュメントではJavaScriptでの実装方法を説明していますが,本ドキュメントではTypeScriptを利用します. 理由として
- ProbotがJavaScriptからTypeScriptに移行しつつある
- JavaScriptと比較してバグを実行前に見つけやすい
ということが挙げられるためです.
また,公式ドキュメントにはありませんが,設定ファイルについてなど,つまづきやすい細かな部分について加筆しています.これらは今後のProbotの仕様変更によって利用できなくなる可能性があります.最新の情報を得たい場合は公式ドキュメントを参照してください.
- Home: Probotの概要
- Prerequisites: 事前知識
- Develop Environment: 開発環境
- Hello World: Probotでの基本的な文法
- Development: Probotの開発チュートリアル
- Webhooks: GitHubからのイベント取得
- File Read: ファイルの読み込み方法
- Issue, Pull Request, User Info: GitHub情報の取得方法
- GitHub API: GitHub APIの利用方法
- HTTP Routes
- Simulating Webhooks
- Testing
- Logging
- Pagination
- Extensions
- Environment Configuration
- Deployment
- Persistence
- Best Practices
- Hello Worldチュートリアルの追加
- 全体の推敲
- 発展項目は優先度低め