Bex Warner
952f88b5b4
Clarifies the Probot requires a webhook secret ( #621 )
...
* Update development.md
* Update configuration.md
* Update configuration.md
* Update development.md
2018-07-13 09:50:42 -07:00
Brandon Keepers
e284ee2567
Tweak formatting of config docs ( #603 )
...
* Move required indicator inline
* Remove example column
* Several tweaks to env docs
1. Sort alphabetically
2. Tweak descriptions
3. Clearer pattern for default values: `Default: <value>`
* implement @tcbyrd's idea for examples
2018-07-10 15:40:04 -07:00
Brian Douglas
1aaf280776
update the example app id image ( #606 )
...
* update the example app id image
per https://github.com/probot/probot/issues/600
* updates image to remove retina blurryness
2018-07-04 20:10:38 -07:00
Bex Warner
eef84796ed
Update links for our API ( #604 )
...
* Update hello-world.md
* Update best-practices.md
2018-07-02 09:17:37 -07:00
Bex Warner
866929f2aa
Revert "Configuration: DISABLE_STATS=true" ( #591 )
...
* Revert "chore(package): update @types/jest to version 23.0.0 (#555 )"
This reverts commit dee76d207b .
* Revert "docs(configuration): DISABLE_STATS=true (#578 )"
This reverts commit 3ac0fa1e68 .
2018-06-27 17:21:49 -07:00
Gregor Martynus
3ac0fa1e68
docs(configuration): DISABLE_STATS=true ( #578 )
2018-06-27 19:15:14 -05:00
Bex Warner
a54243394d
doc: Clarify that WEBHOOK_SECRET needs to match GitHub settings ( #588 )
2018-06-27 09:32:27 -05:00
Alberto Gimeno
8df333ccf8
Adds missing awaits ( #584 )
...
Both `get` and `set` are async in the metadata library. The `await` in `get` is required in this case because otherwise it will always to set a promise on the metadata, which doesn't make sense, and the await in set is required to not swallow the rejection if it fails.
2018-06-26 13:23:50 -07:00
Brent Beer
9920d26cca
docs: clarify GitHub apps as GA in 2.13 and above ( #579 )
2018-06-22 09:25:28 -04:00
Ben Scott
fba83a10c6
docs: Tweak payload info in testing.md ( #575 )
...
This helps enforce the idea that a payload fixture file should be the
webhook payload body, so that the fixture can be referenced by both
tests and `probot simulate`.
2018-06-20 17:26:40 -07:00
Bex Warner
c676d6c561
add backticks ( #574 )
2018-06-20 14:50:27 -07:00
peterennis
f855f51743
docs: Typo ( #572 )
...
s/to customized/to be customized
2018-06-18 21:35:20 -04:00
Jason Etcovitch
de18b9000b
feat: app.load() ( #554 )
2018-06-15 20:14:41 -04:00
Bex Warner
44d2f5aa83
add env config docs ( #544 )
...
* add env config docs
* fix environmental, add quotes
* actually commit all the things
* add npm rules blurb
* dotenv npm wording
* make formatting into a beautiful table
* place ordering before deployment
* fix md tables for gh markdown even though they work in atom readme preview
* specify defaults and add period
2018-06-12 12:59:56 -07:00
Brandon Keepers
2efa0b24b7
chore: Rename robot to app ( #542 )
...
This replaces all internal references to "robot" with "app" or
"Application". There should be no functional change in public APIs, but
may cause some issues for anyone using internal APIs.
2018-06-01 17:45:23 -05:00
Brandon Keepers
bce15ee2e7
docs: webhooks now include node_id ( #552 )
2018-06-01 15:04:10 -05:00
Wei He
5f4340f504
docs: deployment to now ( #548 )
2018-05-29 13:44:50 -07:00
Evan G
a91aa558be
Trigging -> Triggering a webhook ( #545 )
2018-05-23 18:29:00 -05:00
Bo Zhang
a73beeb630
Docs: Missing break statement in "Early exit" example ( #538 )
...
In current example, the `for` loop won't exit unless the missing `break` statement is added.
2018-05-20 07:23:33 -05:00
Brandon Keepers
6ba287f8e4
docs: Add docs on unauthenticated events and a log warning ( #536 )
2018-05-19 08:24:54 -05:00
Pika
1bace4c32c
docs: Remove the docs/deploy.md step... ( #520 )
...
...since the template no longer includes it
2018-05-05 15:17:50 -04:00
Pika
70dd807f36
docs: Remove obsolete step for deploying to Now ( #517 )
2018-05-03 10:33:23 -05:00
Ashantha Lahiru
42e23d43ba
Fix typo ( #515 )
2018-04-24 11:54:48 -04:00
Abhijeet Singh
544e662740
doc: Added details about using the wildcard event ( #504 )
2018-04-22 16:53:40 -04:00
Brandon Keepers
9a26b1a968
docs: Add probot-attachments to extensions list ( #510 )
2018-04-21 09:59:12 -04:00
Aditya Agarwal
3e9bcea693
doc: Modified conflicting in probot-config docs ( #505 )
2018-04-18 18:51:24 -05:00
Aditya Agarwal
0ce45adb21
doc: added documentation for available npm run scripts ( #489 )
...
with the availability of `npm run lint` there is a need for some documentation. As other useful scripts like `test:watch` are being added, I think making a small subsection about them is good
2018-04-15 07:57:21 -07:00
Abhijeet Singh
450b42c090
docs(deployment): log level setting for deployments to now ( #492 )
2018-04-12 12:57:09 -07:00
Tommy Byrd
088e223213
correct featured apps link ( #490 )
2018-04-06 09:38:10 -04:00
Zeke Sikelianos
b00a6f1bb7
docs: Recommend using npm run dev to start with nodemon ( #487 )
2018-04-02 17:11:42 -05:00
Brandon Keepers
3503b1f611
Add GraphQL support ( #472 )
2018-03-21 21:33:16 -05:00
Aditya Agarwal
b0f69c307f
docs: a list of events can also be passed to robot.on() ( #474 )
2018-03-19 08:58:17 -05:00
Abhijeet Singh
19a06c898d
Updated Node.js minimum version required to 8.3.0 ( #464 )
...
Updated Node.js Minimum version required from 7.6 to 8.3.0.
The is because Probot now uses object rest/spread properties, e.g., the rest spread operator: `{ foo, bar, ..., rest } = myObject`
This is available in version 8.3.0 (ES2018). See: [NodeJS ES2018 object rest/spread properties](http://node.green/#ES2018-features-object-rest-spread-properties )
2018-03-17 08:13:22 -05:00
Brandon Keepers
a0f84205f8
Move details on development dependencies to development docs ( #463 )
...
* Move details on development dependencies to development docs
* Link to node website to install
2018-03-15 13:29:41 -05:00
Brandon Keepers
fbc9593091
Docs: encourage people to add their app to the website ( #454 )
2018-03-14 22:27:54 -05:00
Brandon Keepers
e5fe15a0da
Docs: Add error tracking to contents ( #453 )
2018-03-08 21:55:33 -05:00
Alexey Alekhin
ddb5b3d9ba
Raise an error if there are several .pem files ( #441 )
2018-03-08 21:33:46 -05:00
Jason Etcovitch
f94ef2b5ed
docs: Add Summer of Code section to the README ( #448 )
...
* Add summer-of-code section
* RailsGirls -> Rails Girls
2018-03-03 13:43:33 -05:00
Brandon Keepers
ce4727596f
Update node-github => octokit/rest.js in docs ( #445 )
2018-02-28 09:29:47 -06:00
Jason Etcovitch
3e597aabf7
docs: Summer of Code doc ( #435 )
2018-02-25 12:20:13 -05:00
Rahmeen Habib
9394ca1db3
Update docs about glitch deployment ( #421 )
...
* Update deployment.md to clarify what the webhook URL is supposed to look like
2018-02-07 23:57:29 -08:00
Brandon Keepers
c8231b5b2c
Use npx, document yarn ( #417 )
2018-02-03 15:51:53 -05:00
Jamie Strusz
0b1a875108
doc: Add .env.example template info ( #414 )
2018-02-03 15:01:55 -05:00
Thomas Wood
e8fde06df0
Further explicit note on yml config for target repos ( #416 )
...
Follow-up to #415
2018-02-03 14:57:13 -05:00
Victor
d3a47ababa
Payload object explanation in documentation ( #411 )
...
* Payload object explanation
* Little precision about event-name for probot simulate
2018-02-01 11:40:32 -06:00
Daniel Pritchett ⚡
b85d6f372e
More explicit notes on yml config for target repos ( #415 )
2018-02-01 11:16:10 -06:00
Jason Etcovitch
8a5ad67123
Improve docs on probot simulate command ( #405 )
2018-01-28 22:48:04 -06:00
Jason Etcovitch
5e9c0b67ea
docs: Add "next" front matter ( #406 )
2018-01-26 16:01:35 -05:00
Jason Etcovitch
7734e9d283
docs: Add docs for data persistence ( #242 )
2018-01-26 00:01:34 -05:00
Brandon Keepers
b71b2a0135
Remove localtunnel ( #387 )
2018-01-11 21:51:39 -06:00