Skip to content

Commit

Permalink
Sc103415/test instructions (#27)
Browse files Browse the repository at this point in the history
* allow coverage difference to be 0

* readme testing instructions

* de capitalize

* ngrok url instructions

* instructions:

* Update README.md

Co-authored-by: Aries Dimaranan <aasdimaranan@gmail.com>

* Update README.md

Co-authored-by: Aries Dimaranan <aasdimaranan@gmail.com>

* Update README.md

Co-authored-by: Ian Sutherland <ian@iansutherland.ca>

Co-authored-by: Aries Dimaranan <aasdimaranan@gmail.com>
Co-authored-by: Ian Sutherland <ian@iansutherland.ca>
  • Loading branch information
3 people authored Jun 10, 2022
1 parent a3594ba commit a77f313
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,26 @@ Whether or not a response is received the action will print out general informat
"Functions percent": "int"
"Branches percent": "int"
```
These values are the % change in coverage for a particular metric and will be displayed in the `difference` column in the comment posted by the action.

## Contributing

1. Test your changes (see below)
1. Update the version in `package.json`
1. Update `CHANGELOG.md`
1. Commit your changes and open a pull request

### Testing

##### Testing Action changes in this repo

1. In [build.yml](./.github/workflows/build.yml#L30) set the `Upload coverage` step's `uses` clause to `./`
1. Open a pull request to run the `build` workflow. The code on your branch will be run for the `Upload coverage` step. Check the `Upload coverage` step's output for more details about your run.

#### Testing Action against another repository

1. In your repository that references this action, change your workflow's code from
`uses: neofinancial/coverage-upload-action@v1` to `uses: neofinancial/coverage-upload-action@<commit-hash>` where the commit hash is the **full** commit hash you wish to test.
1. If your other repository is running a local server you want to test changes against, make sure you change the `coverageEndpoint` in `build.yml` to an ngrok url that points towards your local server.
1. Run the workflow that references this action.

0 comments on commit a77f313

Please sign in to comment.