From 047a3705a9c7442c593f19731be862059166a51f Mon Sep 17 00:00:00 2001 From: Hugo van Rijswijk Date: Mon, 9 Apr 2018 15:46:26 +0200 Subject: [PATCH] fix(Dashboard reporter): fix typos --- packages/stryker/README.md | 4 ++-- packages/stryker/src/reporters/DashboardReporter.ts | 4 ++-- packages/stryker/test/unit/reporters/DashboardReporterSpec.ts | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/stryker/README.md b/packages/stryker/README.md index b505c5d5e1..8078b95779 100644 --- a/packages/stryker/README.md +++ b/packages/stryker/README.md @@ -186,13 +186,13 @@ for an up-to-date list of supported reporter plugins and a description on each r The `clear-text` reporter supports an additional config option to show more tests that were executed to kill a mutant. The config for your config file is: `clearTextReporter: { maxTestsToLog: 3 },` -The `dashboard` reporter is a special kind of reporter. It sends a report to https://dashboard.stryker-mutator.io, enabling you to add a fancy mutation score badge to your readme! To make sure no unwanted results are send to the dashboards, it will only send the report if it is run from a build server. The only build server supported at the moment is travis (please open an [issue](https://github.com/stryker-mutator/stryker/issues/new) if your build server is missing). The reporter uses these environment settings: +The `dashboard` reporter is a special kind of reporter. It sends a report to https://dashboard.stryker-mutator.io, enabling you to add a fancy mutation score badge to your readme! To make sure no unwanted results are sent to the dashboards, it will only send the report if it is run from a build server. The only build server supported at the moment is travis (please open an [issue](https://github.com/stryker-mutator/stryker/issues/new) if your build server is missing). The reporter uses these environment settings: | Environment variable | Description | Example value | | ------------- | ------------- | ----- | | TRAVIS | Make sure we're running on the build server | TRUE | | TRAVIS\_PULL\_REQUEST | All PR builds are ignored by default | false | -| TRAVIS\_BRANCH | The branch to be send along with the report | master | +| TRAVIS\_BRANCH | The branch to be sent along with the report | master | | STRYKER\_DASHBOARD\_API\_KEY | Your api key (generated for this repository on https://dashboard.stryker-mutator.io) | `52248872-2edc-4102-a43a-bcfca7a9ca99` | All `TRAVIS` environment variables are set by Travis for each build. However, you will need to pass the `STRYKER\_DASHBOARD\_API\_KEY` environment variable yourself. You can create one for your repository by logging in on [the stryker dashboard](https://dashboard.stryker-mutator.io). We strongly recommend you use [encrypted environment variables](https://docs.travis-ci.com/user/environment-variables/#Encrypting-environment-variables). diff --git a/packages/stryker/src/reporters/DashboardReporter.ts b/packages/stryker/src/reporters/DashboardReporter.ts index 02266b3e37..f118e97421 100644 --- a/packages/stryker/src/reporters/DashboardReporter.ts +++ b/packages/stryker/src/reporters/DashboardReporter.ts @@ -43,10 +43,10 @@ export default class DashboardReporter implements Reporter { }); } } else { - this.log.info('Dashboard report is not send when build is for a pull request {TRAVIS_PULL_REQUEST=}'); + this.log.info('Dashboard report is not sent when build is for a pull request {TRAVIS_PULL_REQUEST=}'); } } else { - this.log.info('Dashboard report is not send when stryker didn\'t run on buildserver {TRAVIS=true}'); + this.log.info('Dashboard report is not sent when stryker didn\'t run on buildserver {TRAVIS=true}'); } } } \ No newline at end of file diff --git a/packages/stryker/test/unit/reporters/DashboardReporterSpec.ts b/packages/stryker/test/unit/reporters/DashboardReporterSpec.ts index 7e9dbb4945..c8e0a3bf94 100644 --- a/packages/stryker/test/unit/reporters/DashboardReporterSpec.ts +++ b/packages/stryker/test/unit/reporters/DashboardReporterSpec.ts @@ -71,7 +71,7 @@ describe('DashboardReporter', () => { // Assert expect(dashboardClientMock.postStrykerDashboardReport).to.have.not.been.called; - expect(log.info).to.have.been.calledWithMatch('Dashboard report is not send when stryker didn\'t run on buildserver {TRAVIS=true}'); + expect(log.info).to.have.been.calledWithMatch('Dashboard report is not sent when stryker didn\'t run on buildserver {TRAVIS=true}'); }); it('should log a info if it is a pull request', async () => { @@ -84,7 +84,7 @@ describe('DashboardReporter', () => { // Assert expect(dashboardClientMock.postStrykerDashboardReport).to.have.not.been.called; - expect(log.info).to.have.been.calledWithMatch('Dashboard report is not send when build is for a pull request {TRAVIS_PULL_REQUEST=}'); + expect(log.info).to.have.been.calledWithMatch('Dashboard report is not sent when build is for a pull request {TRAVIS_PULL_REQUEST=}'); }); it('should log a warning if the repository is unknown', async () => {