diff --git a/README.md b/README.md index 37d0d24..a9b6a07 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,34 @@ steps: ``` >**Note**: This assumes that you've set your Codecov token inside settings > secrets as `CODECOV_TOKEN`. If not, you can get an upload token for your specific repo on codecov.io. A token is not required for public repositories. +### Example `workflow.yml` with Codecov Action + +```yaml +name: Example workflow for Codecov +on: [push] +jobs: + run: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + + - name: Setup Python + uses: actions/setup-python@master + with: + version: 3.7 + + - name: Generate coverage report + run: | + pip install pytest + pip install pytest-cov + pytest --cov=./ --cov-report=xml + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v0.2 + with: + token: ${{secrets.CODECOV_TOKEN}} +``` + ## Arguments | Argument | Description |