Commit Graph

246 Commits

Author SHA1 Message Date
Brandon Keepers c254a68c3f Merge pull request #136 from probot/simulate
Simulate command
2017-07-22 09:26:11 -05:00
Brandon Keepers a796b5be1d
Document event simulation 2017-07-22 09:24:12 -05:00
Zeke Sikelianos db76238600 document tailing logs on heroku 2017-07-20 22:03:34 -07:00
AJ Jordan 331807dd15 Don't capitalize npm 2017-07-07 22:21:11 -05:00
Jason Etcovitch 96d2ba1960 Fix typo
Fixes a typo. `a organization` to `an organization`.
2017-06-28 16:26:56 -05:00
Bex Warner abeb46b59d changing doc again 2017-06-16 11:32:07 -07:00
Bex Warner 75f2f77b51 Update the readme 2017-06-16 10:25:13 -07:00
Katrina Owen 5dbfd72b68 Rename a reference to the combined context
In #158 the event and context arguments to the callback got combined into one.
The documentation was still referring to the event object, which is no longer present.
2017-06-15 17:20:01 -06:00
Brandon Keepers b65d239772
Merge event and context arguments 2017-06-11 17:31:47 -05:00
Brandon Keepers fdfbaeafac
Update name from "GitHub Integrations" to "GitHub Apps" 2017-06-05 21:11:08 -05:00
Brandon Keepers 04e9760751
update response format in docs 2017-06-04 09:46:35 -05:00
Brandon Keepers 8ea451e366 Merge pull request #143 from stkent/patch-1
Fix typo in plugins documentation
2017-05-22 05:26:14 -05:00
Brandon Keepers 929447c31f Merge pull request #144 from stkent/patch-2
Update docs on running plugins locally
2017-05-22 05:25:23 -05:00
Brandon Keepers dfce2bdfba Merge pull request #145 from stkent/patch-3
Clarify development install flow
2017-05-22 05:23:14 -05:00
Stuart Kent f4f9be78ab Fix typo in development docs 2017-05-22 10:18:05 +01:00
Stuart Kent d63cf162c0 Clarify development install flow
The "Install" button used to install an integration lives on the settings page of the integration, not on the settings page of the target repository.
2017-05-22 10:16:59 +01:00
Stuart Kent 39f4029820 Update docs on running plugins locally
These instructions referred to a file `autoresponder.js` which does not exist (a) for a plugin in general, or (b) for the autoresponder plugin in particular. The plugin template repo contains a file named `index.js` to export the plugin module, and this naming scheme seems to have been adopted widely (e.g. autoresponder, stale plugins both use `index.js`).
2017-05-22 09:56:15 +01:00
Stuart Kent af8e85eafe Fix typo in plugins documentation 2017-05-22 09:35:14 +01:00
Brandon Keepers fbda62ee5b Update plugins.md 2017-05-04 11:17:26 -05:00
Brandon Keepers d883578e10
Add three laws & empathy 2017-04-29 16:19:27 -05:00
Brandon Keepers eae31f1a1b
Fix URL to API docs 2017-04-29 11:29:00 -05:00
Brandon Keepers 00aff2385a
Merge remote-tracking branch 'origin/master' into jsdoc
* origin/master: (45 commits)
  Fix lint errors
  Upate tests to handle async callback
  Update docs
  Pass an authenticated client to context
  Log unhandled rejections
  Find private key if it is not set
  add .js ext to files in bin/; closes #129
  add PRIVATE_KEY_PATH env var support; closes #122
  ensure "start" script runs from local directory
  enable autodiscovery of plugins; closes #99
  use function expressions in suite and test blocks
  Update filename
  Edits
  fix formatting
  Contents
  Heroku docs
  edits
  Release v0.4.1.
  Disable raven console alerts
  Relax node version requirements
  ...

# Conflicts:
#	docs/api.md
#	lib/context.js
#	lib/robot.js
#	package.json
2017-04-29 09:29:01 -05:00
Brandon Keepers dbb59693f1
Update docs 2017-04-29 08:20:42 -05:00
Christopher Hiller 0f14bf3499 add PRIVATE_KEY_PATH env var support; closes #122
The loading preference is:

1. CLI flag
2. `PRIVATE_KEY`
3. `PRIVATE_KEY_PATH`
4. Find a `.pem` file in the current working dir

Changes:

- break out PK loading logic into module `lib/private-key.js`
- add more info to error messaging if probot fails to find a PK
- add tests
- add note to deployment docs
2017-04-24 23:02:48 -07:00
Brandon Keepers aadf2d6e73
Update filename 2017-04-09 01:37:24 -05:00
Brandon Keepers 0ef380a6fd
Edits 2017-04-08 23:22:05 -05:00
Brandon Keepers 50983e5d76
fix formatting 2017-04-08 23:19:30 -05:00
Brandon Keepers 771e1e616f
Contents 2017-04-08 23:18:57 -05:00
Brandon Keepers c535483beb
Heroku docs 2017-04-08 23:16:00 -05:00
Brandon Keepers 558abda719
edits 2017-04-08 23:02:57 -05:00
Brandon Keepers d46c3a25fb
Merge remote-tracking branch 'origin/master' into doc-deploy
* origin/master: (27 commits)
  Release v0.4.1.
  Disable raven console alerts
  Relax node version requirements
  Release v0.4.0.
  Update log for local server
  Remove tunnel script
  Move subdomain config
  Update docs to use localtunnel
  Add subdomain option
  Setup tunnel using localtunnel
  Ensure node version is satisfied
  autoBreadcrumbs
  Use local logger variable
  Connect sentry to logger
  Move logger setup to index
  Fix package.json for multiple plugins
  Specific filename not needed
  Remove log
  Ignore all private keys
  Look for any pem in the cwd
  ...
2017-04-08 22:57:19 -05:00
Brandon Keepers dc78001254
Update docs to use localtunnel 2017-04-08 17:12:48 -05:00
Brandon Keepers f3073ca8b2 Fix package.json for multiple plugins 2017-04-08 09:01:40 -05:00
Brandon Keepers ceaea351b9
Specific filename not needed 2017-04-08 08:51:31 -05:00
Lee Dohm 8843f6f21e
Add 'dry run' recommendation 2017-04-03 15:29:36 -07:00
Brandon Keepers 15508e8ae1
Directions for deploying to Now 2017-04-02 10:57:37 -05:00
Brandon Keepers 03193ad44e
Start documenting best practices 2017-04-02 09:43:24 -05:00
Brandon Keepers 52917d346b
Merge remote-tracking branch 'origin/master' into jsdoc
* origin/master: (21 commits)
  Update paginate to default to returning response
  capture unhandled rejections
  Fix lint errors
  Add raven to report errors to sentry
  Release v0.3.0.
  Change level of log message
  Start with array
  Use `function` to preserve `this`
  Add docs on paginate method
  Fix lint errors
  robot.auth as integration or installation
  Add paginate to default github client object
  Release v0.2.1.
  Hack to throttle requests
  Remove env variables
  Fix travis version
  Add cache and cache installation token
  a
  chore(package): update xo to version 0.19.0
  Clarify that it's the _webhook_ secret
  ...
2017-04-01 22:59:25 -05:00
Brandon Keepers b8366bda35
Add docs on paginate method 2017-03-30 16:00:39 -07:00
Brandon Keepers cbad7462d1 Clarify that it's the _webhook_ secret 2017-03-25 08:25:56 -05:00
Brandon Keepers c0d8f4d112 Fix formatting 2017-03-20 10:35:41 -05:00
Brandon Keepers 6af993ad1f
Move API docs inline 2017-03-20 00:36:51 -05:00
Brandon Keepers 6ac5b45464
Start of deploy docs 2017-03-19 23:19:09 -05:00
Brandon Keepers 989586b293
Update plugin docs 2017-03-19 23:19:09 -05:00
Brandon Keepers e11927dfcd
Add API docs 2017-03-19 23:19:09 -05:00
Brandon Keepers 7316dae28a
Update development docs 2017-03-19 23:19:08 -05:00
Brandon Keepers 56079928fb
Remove workflow demo
Moved to https://github.com/probot/workflow/blob/master/docs/demo.js
2017-03-19 13:41:58 -05:00
Brandon Keepers 5ba0d012c6
Update plugin docs 2017-03-18 12:42:11 -05:00
Brandon Keepers 3687f99db1
Add docs on logging 2017-03-14 17:49:09 -05:00
Brandon Keepers 780b7970bb
More updates to docs 2017-03-13 10:38:42 -05:00
Brandon Keepers a44116eb36
Edits 2017-03-12 10:54:31 -05:00
Brandon Keepers 75c30f6002
Remove old documentation 2017-03-12 10:51:00 -05:00
Brandon Keepers e5c0ee9680
Add plugin docs 2017-03-12 10:48:09 -05:00
Brandon Keepers 1ba24b11f6
Merge remote-tracking branch 'origin/master' into demo
* origin/master: (25 commits)
  Add Context.halt() function to make halting a rule simple
  Update examples
  💚 Update integration tests
  Stop using const because state was leaking between tests
  🎨
  Add a bunch of Workflow tests
  Add specs for Filter.on()
  Add Filter plugin
  Remove payload module
  Move GitHub Integration code to a module
  Rename server.js to index.js
  Move server implementation to separate file
  typo
  Clean up docs
  Revert "Add routing plugin"
  Move requires to avoid circular dependencies
  Add documentation for createIssue
  Fix syntax errors
  Add labels and assignees
  Add routing plugin
  ...

# Conflicts:
#	package.json
2017-03-11 07:59:22 -06:00
Brandon Keepers 3142422e02
Tweak deleted message 2017-03-11 07:58:22 -06:00
Brandon Keepers 0e4c2d8117
Ingore comments from all bot users 2017-03-11 07:58:15 -06:00
Lee Dohm 48b5b3f8ba
Update examples 2017-03-01 13:37:01 -08:00
Brandon Keepers 242f712c9f typo 2017-01-25 22:54:43 -06:00
Brandon Keepers 92d69c97c8 Clean up docs
- consistent use of quotes (always single quote)
- `js` syntax highlighting for everything
2017-01-25 22:53:59 -06:00
Michael Johnson 74f387b196 Add documentation for createIssue 2017-01-25 19:55:08 -07:00
Johannes Nicolai cb5c538383 Removing duplicate welcome example as it is included in README.md 2016-12-07 19:06:50 +01:00
Johannes Nicolai 4ed502951d Added two further examples and kept the original example in README.md 2016-12-07 19:04:27 +01:00
Brandon Keepers 5404a44fd9
Configure xo to work with probot scripts 2016-12-07 09:56:50 -06:00
Brandon Keepers 1d9eed64ee
Start a demo script 2016-12-07 09:51:38 -06:00
Brandon Keepers 8411487998
Fix examples of content 2016-12-07 09:47:13 -06:00
Brandon Keepers 65c00d689c Remove link to "then" 2016-12-07 09:39:51 -06:00
Brandon Keepers e01c865e1c
Add docs for `deleteComment` 2016-12-04 23:29:44 -06:00
Brandon Keepers fc6fefa1f1
Rename load => include 2016-12-04 16:36:42 -06:00
Brandon Keepers fe698f09f8
Add docs for load 2016-12-04 16:20:52 -06:00
Brandon Keepers a20c245a8f
Fix headings 2016-12-04 16:20:36 -06:00
Brandon Keepers 66573e43e9
add label example 2016-11-20 22:01:48 -06:00
Brandon Keepers 90708f3fba
Remove reactions, which are not supported by integrations 2016-11-20 21:31:36 -06:00
Brandon Keepers 7187c9c258
Update docs 2016-11-17 22:38:09 -06:00
Matt Colyer b58d51d4df
Update docs, js arrow functions don't have `this` 2016-11-16 14:36:25 -08:00
Brandon Keepers 6ddb997b7c
Experiment with examples as pure JS 2016-11-15 22:42:17 -06:00
Brandon Keepers 2397c7070a
Add docs on negation 2016-11-03 20:37:04 -05:00
Brandon Keepers c526432b73
Fix headings 2016-10-30 11:50:06 -05:00
Brandon Keepers ff3a0106da
Update examples 2016-10-30 11:48:52 -05:00
Brandon Keepers 338b15f6b4
Update examples 2016-10-29 15:09:08 -05:00
Brandon Keepers 84670eaa5d
Initial docs on conditions 2016-10-29 09:56:58 -05:00
Brandon Keepers c0e9fff4eb
Update docs 2016-10-19 23:32:26 -05:00
Brandon Keepers 574d2c599f
Update docs 2016-10-18 00:41:55 -05:00
Brandon Keepers 133dce25e6
Document react action 2016-10-16 23:35:28 -05:00
Brandon Keepers 79e991bcf6
Remove unimplemented examples from README 2016-10-16 23:28:09 -05:00
Brandon Keepers f7bc9a183e
Fix then syntax 2016-10-16 23:19:30 -05:00
Brandon Keepers eba555d5f6
Update not at top of readme 2016-10-16 23:19:24 -05:00
Brandon Keepers 62d4a8abdb
Move aspirational examples to separate file 2016-10-16 23:16:57 -05:00
Brandon Keepers 4d76cc1f9e
Remove unimplemented merge action 2016-10-16 23:07:27 -05:00
Brandon Keepers 2858724b1c
Remove unimplemented from_file option
cc https://github.com/bkeepers/PRobot/issues/42
2016-10-16 23:06:56 -05:00
Brandon Keepers 29295ddc50
Remove unimplemented payload conditions
cc https://github.com/bkeepers/PRobot/issues/41
2016-10-16 23:00:54 -05:00
Brandon Keepers fb38a39fcf
Remove interit_from syntax
cc https://github.com/bkeepers/PRobot/issues/40
2016-10-16 22:48:01 -05:00
Brandon Keepers 5352a49912
Fix event names 2016-10-12 11:17:40 -05:00
Brandon Keepers 147b2d755a
a few other crazy ideas 2016-10-10 09:35:54 -05:00
Brandon Keepers 2eebbdc1ec
Split up refactored dispatcher 2016-10-10 01:26:34 -05:00
Brandon Keepers e6126e87cf
behaviors 2016-10-10 00:04:45 -05:00
Brandon Keepers 251e853a73
Aspirational docs 2016-10-09 23:38:22 -05:00