Returns a boolean if the actor on the event was a bot.
Reads the app configuration from the given YAML file in the .github
directory of the repository.
For example, given a file named .github/config.yml:
close: true
comment: Check the specs on the rotary girder.Your app can read that file from the target repository:
// Load config from .github/config.yml in the repository
const config = await context.config('config.yml')
if (config.close) {
context.github.issues.comment(context.issue({body: config.comment}))
context.github.issues.edit(context.issue({state: 'closed'}))
}You can also use a defaultConfig object:
// Load config from .github/config.yml in the repository and combine with default config
const config = await context.config('config.yml', {comment: 'Make sure to check all the specs.'})
if (config.close) {
context.github.issues.comment(context.issue({body: config.comment}));
context.github.issues.edit(context.issue({state: 'closed'}))
}Config files can also specify a base that they extend. deepMergeOptions can be used
to configure how the target config, extended base, and default configs are merged.
Name of the YAML file in the .github directory
An object of default config options
Controls merging configs (from the deepmerge module)
Configuration object read from the file
Return the owner, repo, and number params for making API requests
against an issue or pull request. The object passed in will be merged with
the repo params.
const params = context.issue({body: 'Hello World!'})
// Returns: {owner: 'username', repo: 'reponame', number: 123, body: 'Hello World!'}Params to be merged with the issue params.
Return the owner and repo params for making API requests against a
repository.
const params = context.repo({path: '.github/config.yml'})
// Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}Params to be merged with the repo params.
Generated using TypeDoc
The context of the event that was triggered, including the payload and helpers for extracting information can be passed to GitHub API calls.
module.exports = app => { app.on('push', context => { context.log('Code was pushed to the repo, what should we do with it?'); }); };{github} github - A GitHub API client
{payload} payload - The webhook event payload
{logger} log - A logger