Skip to content

Commit

Permalink
Introduce instructions for measuring test coverage (#75)
Browse files Browse the repository at this point in the history
* Add docs for test coverage

* Run go mod tidy for building purposes
  • Loading branch information
kfcampbell authored Jun 4, 2024
1 parent 5afc170 commit e877d63
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ See example client instantiations and requests in [example_test.go](pkg/example_

⚠️ **Note**: This SDK is not yet stable. Breaking changes may occur at any time.

### Building and testing

- Build the SDK: `go build ./...`
- Test the SDK: `go test ./...`
- Measure test coverage by package (e.g. `authentication`): `go test -v -coverpkg=./pkg/authentication -coverprofile=auth.cov ./pkg/authentication`
- Test coverage may be viewed in VS Code by running the command `Go: Toggle Test Coverage In Current Package`
- Alternately, you may run `go tool cover -html auth.cov -o auth.html` and open the generated `auth.html` file in a browser to view test coverage

### Authentication

This SDK supports [Personal Access Tokens (classic)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic), [fine-grained Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens), and [GitHub Apps](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app) authentication.
Expand Down

0 comments on commit e877d63

Please sign in to comment.