Skip to content

Commit

Permalink
fix(Dashboard reporter): fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
hugo-vrijswijk authored and simondel committed Apr 9, 2018
1 parent 0d0fe96 commit 047a370
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions packages/stryker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions packages/stryker/src/reporters/DashboardReporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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=<number>}');
this.log.info('Dashboard report is not sent when build is for a pull request {TRAVIS_PULL_REQUEST=<number>}');
}
} 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}');
}
}
}
4 changes: 2 additions & 2 deletions packages/stryker/test/unit/reporters/DashboardReporterSpec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 () => {
Expand All @@ -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=<number>}');
expect(log.info).to.have.been.calledWithMatch('Dashboard report is not sent when build is for a pull request {TRAVIS_PULL_REQUEST=<number>}');
});

it('should log a warning if the repository is unknown', async () => {
Expand Down

0 comments on commit 047a370

Please sign in to comment.