Skip to content

Commit c578984

Browse files
committed
#11 Fix params grammar
1 parent 90c99d6 commit c578984

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

action.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ branding:
66
color: "orange"
77
inputs:
88
config-path:
9-
description: "File where your configuration is located, for example `.config/stryker-config.json`. More info here https://stryker-mutator.io/docs/stryker-net/configuration/"
9+
description: "File path where configuration is located, for example `.config/stryker-config.json`. More info here https://stryker-mutator.io/docs/stryker-net/configuration"
1010
required: false
1111
dashboard-api-key:
12-
description: "Stryker dashboard API key. More info here https://stryker-mutator.io/docs/General/dashboard/"
12+
description: "Stryker dashboard API key. More info here https://stryker-mutator.io/docs/General/dashboard"
1313
required: false
1414
report-source-branch:
1515
description: "Run stryker report in current source branch (for default branch this parameter is always true)"
@@ -20,11 +20,11 @@ inputs:
2020
required: false
2121
default: "false"
2222
upload-report:
23-
description: "Upload your report to GitHub cloud https://github.com/actions/upload-artifact"
23+
description: "Upload report to GitHub cloud https://github.com/actions/upload-artifact"
2424
required: false
2525
default: "true"
2626
send-report-message:
27-
description: "Send report message when you open PR (add `permissions.pull-requests: write` to your action https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)"
27+
description: "Send report message when PR is opened (add `permissions.pull-requests: write` to action https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token)"
2828
required: false
2929
default: "true"
3030
runs:
@@ -145,14 +145,14 @@ runs:
145145
146146
if [[ "$REPORT_SOURCE_BRANCH_DIFF" == "true" ]]; \
147147
then
148-
echo "REPORT_SOURCE_BRANCH_DIFF_BADGE=[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https://badge-api.stryker-mutator.io/github.com/${{ env.FULL_REPO_NAME }}/${{ env.SOURCE_BRANCH }}-diff)](https://dashboard.stryker-mutator.io/reports/github.com/${{ env.FULL_REPO_NAME }}/${{ env.SOURCE_BRANCH }}-diff#mutant)" >> $GITHUB_ENV
148+
echo "REPORT_SOURCE_BRANCH_DIFF_BADGE=[![Mutation testing diff badge](https://img.shields.io/endpoint?style=flat&url=https://badge-api.stryker-mutator.io/github.com/${{ env.FULL_REPO_NAME }}/${{ env.SOURCE_BRANCH }}-diff)](https://dashboard.stryker-mutator.io/reports/github.com/${{ env.FULL_REPO_NAME }}/${{ env.SOURCE_BRANCH }}-diff#mutant)" >> $GITHUB_ENV
149149
else
150150
echo "REPORT_SOURCE_BRANCH_DIFF_BADGE=---" >> $GITHUB_ENV
151151
fi
152152
153153
if [[ "$UPLOAD_REPORT" == "true" ]]; \
154154
then
155-
echo "UPLOAD_REPORT_BADGE=[![Static Badge](https://img.shields.io/badge/download-report-blue)](${{ steps.artifact-upload-step.outputs.artifact-url }})" >> $GITHUB_ENV
155+
echo "UPLOAD_REPORT_BADGE=[![Upload report badge](https://img.shields.io/badge/download-report-blue)](${{ steps.artifact-upload-step.outputs.artifact-url }})" >> $GITHUB_ENV
156156
else
157157
echo "UPLOAD_REPORT_BADGE=---" >> $GITHUB_ENV
158158
fi
@@ -170,8 +170,8 @@ runs:
170170
171171
| Description | Badge |
172172
| ------------ | ----- |
173-
| Diff between `${{ env.TARGET_BRANCH }}` (target branch) and `${{ env.SOURCE_BRANCH }}` (source branch) | ${{ env.REPORT_SOURCE_BRANCH_DIFF_BADGE }} |
174-
| `${{ env.SOURCE_BRANCH }}` (source branch) statistics | ${{ env.REPORT_SOURCE_BRANCH_BADGE }} |
175-
| `${{ env.TARGET_BRANCH }}` (target branch) statistics | [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https://badge-api.stryker-mutator.io/github.com/${{ env.FULL_REPO_NAME }}/${{ env.TARGET_BRANCH }})](https://dashboard.stryker-mutator.io/reports/github.com/${{ env.FULL_REPO_NAME }}/${{ env.TARGET_BRANCH }}#mutant) |
173+
| Diff between target branch (`${{ env.TARGET_BRANCH }}`) and source branch (`${{ env.SOURCE_BRANCH }}`) | ${{ env.REPORT_SOURCE_BRANCH_DIFF_BADGE }} |
174+
| Source branch `${{ env.SOURCE_BRANCH }}` statistics | ${{ env.REPORT_SOURCE_BRANCH_BADGE }} |
175+
| Target branch `${{ env.TARGET_BRANCH }}` statistics | [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https://badge-api.stryker-mutator.io/github.com/${{ env.FULL_REPO_NAME }}/${{ env.TARGET_BRANCH }})](https://dashboard.stryker-mutator.io/reports/github.com/${{ env.FULL_REPO_NAME }}/${{ env.TARGET_BRANCH }}#mutant) |
176176
| Download report from GitHub storage | ${{ env.UPLOAD_REPORT_BADGE }} |
177177
if: "${{ github.event_name == 'pull_request' && inputs.send-report-message == 'true' }}"

0 commit comments

Comments
 (0)