Skip to content

Commit e02a039

Browse files
chore: remove deprication notice (#31)
The test coverage action now runs without any additional steps. We have made changes to pick up commit OIDs from env vars set by GitHub Actions. This means no git commands would need to be run, and safe directory addition is not required anymore. Signed-off-by: Srijan Saurav <[email protected]>
1 parent 3a1fbf4 commit e02a039

File tree

1 file changed

+0
-47
lines changed

1 file changed

+0
-47
lines changed

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,53 +6,6 @@ GitHub Action that enables you to upload your test coverage data to DeepSource e
66

77
If you're not using DeepSource yet, [get started for free](https://deepsource.io/signup?utm_source=githubmarketplace&utm_medium=organic).
88

9-
## Notice
10-
11-
If you’re using the Test coverage action, we recommend switching to using the DeepSource CLI directly.
12-
To do this, rather than using the `test-coverage-action` step, you can do the following:
13-
14-
```yaml
15-
steps:
16-
- name: Checkout code
17-
uses: actions/checkout@v2
18-
with:
19-
ref: ${{ github.event.pull_request.head.sha }}
20-
21-
# Run your tests here ...
22-
23-
- name: Report test-coverage to DeepSource
24-
run: |
25-
# Install the CLI
26-
curl https://deepsource.io/cli | sh
27-
28-
# Send the report to DeepSource
29-
./bin/deepsource report --analyzer test-coverage --key <language> --value-file <path/to/coverage/file>
30-
```
31-
32-
If you want to continue using the Test coverage action, please add a step before the test coverage action, to add a
33-
`safe.directory` parameter to your `.gitconfig`:
34-
35-
```yaml
36-
steps:
37-
- name: Checkout code
38-
uses: actions/checkout@v2
39-
with:
40-
fetch-depth: 50
41-
ref: ${{ github.event.pull_request.head.sha }}
42-
43-
# ADD THIS STEP
44-
- name: Add git safe.directory for container
45-
run: |
46-
mkdir -p /home/runner/work/_temp/_github_home
47-
printf "[safe]\ndirectory = /github/workspace" > /home/runner/work/_temp/_github_home/.gitconfig
48-
49-
- name: Report test-coverage to DeepSource
50-
uses: deepsourcelabs/test-coverage-action@master
51-
with:
52-
... The rest of your config is explained in Usage section.
53-
```
54-
55-
Read this [Discuss post](https://discuss.deepsource.io/t/breaking-deepsource-test-coverage-github-action/507) for more information.
569

5710
## Usage
5811

0 commit comments

Comments
 (0)