xxq250
/
probot
forked from mirrors/probot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tweak docs

This commit is contained in:
Brandon Keepers 2017-07-27 10:26:52 -05:00
parent 0d41954c3a
commit 1d5da34153
No known key found for this signature in database
GPG Key ID: F9533396D5FACBF6
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lib/context.js
View File

@ -63,17 +63,17 @@ class Context {
}
/**
* Reads the plugin configuration from the given YAML file name in the
* `.github` directory.
* Reads the plugin configuration from the given YAML file in the `.github`
* directory of the repository.
*
* @example
*
* // Load config from .github/myplugin.yml in the repository
* const config = await context.config('myplugin.yml');
*
* if(config.close) {
* context.github.issues.edit(context.issue({state: 'closed'}));
* }
// Load config from .github/myplugin.yml in the repository
const config = await context.config('myplugin.yml');
if(config.close) {
context.github.issues.edit(context.issue({state: 'closed'}));
}
*
* @param {string} fileName Name of the YAML file in the `.github` directory
* @return {Promise<Object>} Configuration object read from the file