forked from mirrors/probot
fix: Spelling (#800)
This commit is contained in:
parent
15fbadca2d
commit
444fcac73d
|
@ -3,7 +3,7 @@ template: >
|
||||||
- [ ] Sort changes into relevant sections below
|
- [ ] Sort changes into relevant sections below
|
||||||
- [ ] Replace `master` with next tag in "See full changelog" link
|
- [ ] Replace `master` with next tag in "See full changelog" link
|
||||||
- [ ] Delete this TODO list
|
- [ ] Delete this TODO list
|
||||||
- [ ] Hit pubish
|
- [ ] Hit publish
|
||||||
|
|
||||||
## Breaking Changes
|
## Breaking Changes
|
||||||
|
|
||||||
|
|
|
@ -28,7 +28,7 @@ if (!program.event || !program.payloadPath) {
|
||||||
|
|
||||||
const cert = findPrivateKey()
|
const cert = findPrivateKey()
|
||||||
if (!githubToken && (!program.app || !cert)) {
|
if (!githubToken && (!program.app || !cert)) {
|
||||||
console.warn('No token specified and no certifiate found, which means you will not be able to do authenticated requests to GitHub')
|
console.warn('No token specified and no certificate found, which means you will not be able to do authenticated requests to GitHub')
|
||||||
}
|
}
|
||||||
|
|
||||||
const payload = require(path.resolve(program.payloadPath))
|
const payload = require(path.resolve(program.payloadPath))
|
||||||
|
|
|
@ -173,7 +173,7 @@ GitHub Actions allows you to trigger workflows based on GitHub events, which mak
|
||||||
|
|
||||||
There are a few caveats when running Probot Apps on GitHub Actions:
|
There are a few caveats when running Probot Apps on GitHub Actions:
|
||||||
|
|
||||||
- The GitHub API token available to actions has a [fixed set of permisisons](https://developer.github.com/actions/creating-workflows/storing-secrets/#github-token-secret), and only has access to the repository that triggered the action. `app.auth()` will always return a GitHub client authenticated for the current repository.
|
- The GitHub API token available to actions has a [fixed set of permissions](https://developer.github.com/actions/creating-workflows/storing-secrets/#github-token-secret), and only has access to the repository that triggered the action. `app.auth()` will always return a GitHub client authenticated for the current repository.
|
||||||
- [probot/scheduler](https://github.com/probot/scheduler) and other extensions that require long-running processes are not currently supported.
|
- [probot/scheduler](https://github.com/probot/scheduler) and other extensions that require long-running processes are not currently supported.
|
||||||
- Your app cannot expose [HTTP routes](./http.md)
|
- Your app cannot expose [HTTP routes](./http.md)
|
||||||
|
|
||||||
|
|
|
@ -47,7 +47,7 @@ module.exports = app => {
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, messages that are `info` and above will show in your logs, but you can change it by setting the
|
By default, messages that are `info` and above will show in your logs, but you can change it by setting the
|
||||||
`LOG_LEVEL` environment variable to `trace`, `debug`, `info`, `warn`, `error`, or `fatal` in `.env` or on the comand line.
|
`LOG_LEVEL` environment variable to `trace`, `debug`, `info`, `warn`, `error`, or `fatal` in `.env` or on the command line.
|
||||||
|
|
||||||
```
|
```
|
||||||
$ LOG_LEVEL=debug npm start
|
$ LOG_LEVEL=debug npm start
|
||||||
|
|
|
@ -137,7 +137,7 @@ module.exports = app => {
|
||||||
|
|
||||||
### Firebase
|
### Firebase
|
||||||
|
|
||||||
[Firebase](https://firebase.google.com/) is Google's services-as-a-service that includes a simple JSON database. You can learn more about dealing with the Javascript API [here](https://firebase.google.com/docs/database/web/start). Note that for security purposes, you may also want to look into the [Admin API](https://firebase.google.com/docs/database/admin/start).
|
[Firebase](https://firebase.google.com/) is Google's services-as-a-service that includes a simple JSON database. You can learn more about dealing with the JavaScript API [here](https://firebase.google.com/docs/database/web/start). Note that for security purposes, you may also want to look into the [Admin API](https://firebase.google.com/docs/database/admin/start).
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// index.js
|
// index.js
|
||||||
|
|
|
@ -48,7 +48,7 @@ export class Application {
|
||||||
if (opts.catchErrors) {
|
if (opts.catchErrors) {
|
||||||
// Deprecated since 7.2.0
|
// Deprecated since 7.2.0
|
||||||
// tslint:disable-next-line:no-console
|
// tslint:disable-next-line:no-console
|
||||||
console.warn(new Error('Propery `catchErrors` is deprecated and has no effect'))
|
console.warn(new Error('Property `catchErrors` is deprecated and has no effect'))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -69,7 +69,7 @@ export class Application {
|
||||||
public async receive (event: WebhookEvent) {
|
public async receive (event: WebhookEvent) {
|
||||||
if ((event as any).event) {
|
if ((event as any).event) {
|
||||||
// tslint:disable-next-line:no-console
|
// tslint:disable-next-line:no-console
|
||||||
console.warn(new Error('Propery `event` is deprecated, use `name`'))
|
console.warn(new Error('Property `event` is deprecated, use `name`'))
|
||||||
event = { name: (event as any).event, ...event }
|
event = { name: (event as any).event, ...event }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -43,7 +43,7 @@ export class Context implements WebhookEvent {
|
||||||
this.log = log
|
this.log = log
|
||||||
}
|
}
|
||||||
|
|
||||||
// Maintain backward compatability
|
// Maintain backward compatibility
|
||||||
public get event (): string {
|
public get event (): string {
|
||||||
return this.name
|
return this.name
|
||||||
}
|
}
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* By default, logs are formatted for readability in development. If you intend
|
* By default, logs are formatted for readability in development. If you intend
|
||||||
* to drain logs to a logging service, set `LOG_FORMAT=json`.
|
* to drain logs to a logging service, set `LOG_FORMAT=json`.
|
||||||
*
|
*
|
||||||
* **Note**: All execptions reported with `logger.error` will be forwarded to
|
* **Note**: All exceptions reported with `logger.error` will be forwarded to
|
||||||
* [sentry](https://github.com/getsentry/sentry) if the `SENTRY_DSN` environment
|
* [sentry](https://github.com/getsentry/sentry) if the `SENTRY_DSN` environment
|
||||||
* variable is set.
|
* variable is set.
|
||||||
*
|
*
|
||||||
|
|
|
@ -35,7 +35,7 @@ export const serializers: bunyan.StdSerializers = {
|
||||||
|
|
||||||
req: bunyan.stdSerializers.req,
|
req: bunyan.stdSerializers.req,
|
||||||
|
|
||||||
// Same as buyan's standard serializers, but gets headers as an object
|
// Same as bunyan's standard serializers, but gets headers as an object
|
||||||
// instead of a string.
|
// instead of a string.
|
||||||
// https://github.com/trentm/node-bunyan/blob/fe31b83e42d9c7f784e83fdcc528a7c76e0dacae/lib/bunyan.js#L1105-L1113
|
// https://github.com/trentm/node-bunyan/blob/fe31b83e42d9c7f784e83fdcc528a7c76e0dacae/lib/bunyan.js#L1105-L1113
|
||||||
res: (res: ExpressResponseWithDuration) => {
|
res: (res: ExpressResponseWithDuration) => {
|
||||||
|
|
|
@ -24,7 +24,7 @@ export const wrapLogger = (logger: Logger, baseLogger?: Logger): LoggerWithTarge
|
||||||
delete attrs.name
|
delete attrs.name
|
||||||
const log = logger.child(attrs, true)
|
const log = logger.child(attrs, true)
|
||||||
|
|
||||||
// …Sorry, bunyan, doing it anwyway
|
// …Sorry, bunyan, doing it anyway
|
||||||
if (name) {
|
if (name) {
|
||||||
log.fields.name = name
|
log.fields.name = name
|
||||||
}
|
}
|
||||||
|
|
|
@ -70,7 +70,7 @@ describe('stats app', () => {
|
||||||
server.use(app.router)
|
server.use(app.router)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('returns installation count and popular accounts while exclusing spammy users', () => {
|
it('returns installation count and popular accounts while excluding spammy users', () => {
|
||||||
return request(server).get('/probot/stats')
|
return request(server).get('/probot/stats')
|
||||||
.expect(200, { 'installations': 1, 'popular': [] })
|
.expect(200, { 'installations': 1, 'popular': [] })
|
||||||
})
|
})
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
<div class="text-center">
|
<div class="text-center">
|
||||||
<h1 class="alt-h3 mb-2">Congrats! You have successfully installed your app!
|
<h1 class="alt-h3 mb-2">Congrats! You have successfully installed your app!
|
||||||
<br>
|
<br>
|
||||||
Checkout <a href="https://probot.github.io/docs/webhooks/">Recieving webhooks</a> and <a href="https://probot.github.io/docs/github-api/">Interacting with GitHub</a> to learn more!</h1>
|
Checkout <a href="https://probot.github.io/docs/webhooks/">Receiving webhooks</a> and <a href="https://probot.github.io/docs/github-api/">Interacting with GitHub</a> to learn more!</h1>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue