Commit Graph

251 Commits

Author SHA1 Message Date
Gregor c4845298bc docs(configuration): REDIS_URL 2019-03-08 11:16:29 -08:00
JC cb21ca7a22 docs(testing): typo in code example (#834) 2019-03-08 10:00:43 -08:00
Gregor 39f1fc087a docs(pagination): lookie lookie async iterators 👀 2019-03-08 10:00:19 -08:00
Gregor 6a6f456620 docs(github-api): github.graphql is the new github.query and then some 2019-03-08 10:00:19 -08:00
David Klebanoff 22ce38c86a docs(README): fixes wording (#880) 2019-03-06 10:17:43 -08:00
Shelley Vohr c8ed774382 doc: update GitHub actions workflow reference (#823) 2019-01-13 15:30:41 -05:00
Pietro Bongiovanni 6b73d5a746 docs: Fix URL for Serverless GCF repository (#805) 2019-01-04 13:42:31 -05:00
Kentaro Matsushita dc558dcef5 docs: Fix sample code for serverless deployment (#807) 2019-01-04 13:41:25 -05:00
Josh Soref 444fcac73d fix: Spelling (#800) 2019-01-03 12:15:02 -05:00
Mayank Jethva bb06c51485 docs(simulating-webhooks.md): typo and `pull_request.labeled` keyword highlight (#796) 2018-12-21 10:36:39 -08:00
Chad Fawcett 5063300606 Fix link to "probot-metadata" extension (#787)
Fix broken link
2018-12-12 01:03:43 -05:00
Chad Fawcett e1d80a96f3 Fix link to "Create the GitHub App" (#786) 2018-12-11 23:37:56 -05:00
Andrew Hinett fee5451482 docs: fix misspellings of receive (#783) 2018-12-11 07:57:08 -08:00
Matan Kushner 5c622e4ee9 docs: links in "Serverless Deployment" (#773) 2018-11-19 14:27:42 -08:00
Timon van Spronsen 5443ce03c8 Add documentation about template flag (#752)
* Add documentation about template flag

* Update docs/development.md

Co-Authored-By: TimonVS <timonvanspronsen@outlook.com>

* Update docs/development.md

Co-Authored-By: TimonVS <timonvanspronsen@outlook.com>

* Improve `template` argument documentation

* update template step
2018-10-31 23:02:15 -04:00
Bex Warner 9e60d34710
Follow GitHub Casing Standards (#756)
* casing is lyfe #gIThUB

* Update docs/configuration.md

Co-Authored-By: hiimbex <bexmwarner@gmail.com>

* Update docs/configuration.md

Co-Authored-By: hiimbex <bexmwarner@gmail.com>
2018-10-31 22:42:03 -04:00
Bex Warner 286f2d4916 Improve documentation on testing Probot apps with nock (#734) 2018-10-25 15:35:24 -05:00
Brian Douglas 787e36f2ad Create serverless-deployment.md (#698)
* Create serverless-deployment.md

I have worked alongside @tcbyrd and @JasonEtco testing out their Serverless plugins in preparation for a Serverless conference I am attending this week. Having a Serverless section would be nice to share while at the conference, but not required.

This PR adds a new Serverless section to the docs (open to suggestions on placement), @hiimbex mentioned creating a new section to assist not over-crowding the (already existing) deployment.md.

After this week, I plan to begin working with another provider (Azure).

* Update deployment.md

* Bdougie pr serverless fixes (#2)

* adds link to serverless docs

* link to deployments section for repeated content

* Bdougie pr serverless fixes (#3)

* adds link to serverless docs

* link to deployments section for repeated content

* Update serverless-deployment.md

* adds serverless blurb

* Update deployment.md

* Update serverless-deployment.md

* Update deployment.md

* Update serverless-deployment.md

* a few grammar and word changes
2018-10-25 15:15:04 -04:00
Kunall Banerjee 06d2767607 docs: Fix typo (#741) 2018-10-23 01:39:27 -04:00
Brandon Keepers 76b0417745
robot => app 2018-10-16 11:20:53 -07:00
Brandon Keepers 133496bc88
Document deployment to GitHub Actions (#739) 2018-10-16 11:16:26 -07:00
Bex Warner 76b5edd13d Update docs for manually receiving events (#730) 2018-10-15 11:31:31 -07:00
Bex Warner 8964e7c613
Update development.md (#735) 2018-10-10 23:28:37 -04:00
greenkeeper[bot] 914d968045 Update standard-markdown to the latest version 🚀and lint docs
* chore(package): update standard-markdown to version 5.0.0

* chore(package): update standard-markdown to version 5.0.1

Closes #689

* fix linting
2018-10-10 11:54:31 -04:00
Donald Little 3bee037014 remove manual base64 encoding/decoding of private key (#717) 2018-10-03 13:52:42 -04:00
Wilhelm Klopp b9ee5de8fd
Fix two typos (#709) 2018-10-02 09:03:32 +01:00
Bex Warner 1e63aa5058
Update development docs to explain GitHub App Manifests (#700)
* Update development.md

* Update development.md

* Update development.md
2018-09-26 15:22:21 -04:00
Maks Rafalko be260ef13c Update best-practices.md (#682) 2018-09-05 16:08:08 -04:00
Augusto Goulart c01361fc60 docs: Response object should call .send() and not .end() (#671) 2018-08-28 23:07:36 -05:00
Brandon Keepers 6ac4a06fd4
Fix link to deployment docs (#669) 2018-08-27 18:41:25 -04:00
Bex Warner 1820442f68
Add probot-messages (#657)
* Update extensions.md

* Update extensions.md
2018-08-19 17:42:02 -05:00
Ben Scott d8383d3b51 Rename event->name in docs (#631)
To be inline with changes in https://github.com/probot/probot/pull/626
2018-08-17 23:16:48 -05:00
Tommy Byrd 59f924e4e6
Add environment variable option to provide a base64 encoded key (#624)
* check for base64 in the PRIVATE_KEY variable

* Update private_key config documentation

* Link to deployment docs for private key usage
2018-08-10 08:07:12 -04:00
Tom Milligan 4118f1d9dc Added env var INSTALLATION_TOKEN_TTL (#638)
* Add env var INSTALLATION_TOKEN_TTL

* Fixed jest tests not running under yarn with insecure localhost warning

* Update configuration.md

* Added integration nock tests for Application auth cache

* Fix test comment typo

* Clean global variables both before and after auth cache tests
2018-08-07 08:11:51 -07:00
Ben Scott d712141868 Refer to instances of ApplicationFunction as appFn (#633)
Stop using the names 'plugin' and 'app' to refer to instances of
ApplicationFunction.

This renames all variable names, but leaves the plugins folder in place,
to be renamed later
2018-08-02 14:47:27 -04:00
Rahman 80fc41ad14 Add typescript option to npx/yarn command (#630) 2018-07-23 08:10:24 -07:00
Wilhelm Klopp f3fd6585f1
Bring testing docs in line with probot/template (#627) 2018-07-17 21:01:12 +08:00
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