Skip to content

Commit ebef82f

Browse files
Update TestAll_and_Code_Coverage_CI.md
1 parent 81a2cca commit ebef82f

File tree

1 file changed

+6
-33
lines changed

1 file changed

+6
-33
lines changed

.github/workflows/TestAll_and_Code_Coverage_CI.md

Lines changed: 6 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ This repository contains the **Code Coverage CI** GitHub Actions workflow, which
1313
- [Jobs Definition](#jobs-definition)
1414
- [Steps Breakdown](#steps-breakdown)
1515
- [Project Structure](#project-structure)
16-
- [Benefits](#benefits)
17-
- [License](#license)
16+
1817

1918
## Overview
2019

@@ -37,13 +36,13 @@ The **Code Coverage CI** workflow automates testing and code coverage reporting.
3736

3837
2. **Add the Workflow File**:
3938

40-
- Save the provided workflow YAML file as `.github/workflows/codecov.yml` in your repository.
39+
- Save the provided workflow YAML file as `.github/workflows/codecov.yml` in the repository.
4140

4241
3. **Store Codecov Token**:
4342

4443
- In the repository, go to **Settings** > **Secrets and variables** > **Actions**.
4544
- Click on **New repository secret**.
46-
- Add `CODECOV_TOKEN` as the name and paste your Codecov token as the value.
45+
- Add `CODECOV_TOKEN` as the name and paste the Codecov token as the value.
4746

4847
4. **Add MOcov to Your Project** (Optional for local testing):
4948

@@ -61,9 +60,9 @@ The **Code Coverage CI** workflow automates testing and code coverage reporting.
6160

6261
5. **Create `run_coverage_tests.m` Script**:
6362

64-
- Add the `run_coverage_tests.m` script to the root of your repository. This script runs your tests and generates the coverage report using MOcov.
63+
- Add the `run_coverage_tests.m` script to the root of the repository. This script runs tests and generates the coverage report using MOcov.
6564

66-
6. **Organize Your Project**:
65+
6. **Organize Project**:
6766

6867
- **Source Code**: Place your MATLAB source code in the `src` directory.
6968
- **Tests**: Place test files in the `test` directory. Ensure `testAll.m` or your main test script is in this directory.
@@ -104,7 +103,7 @@ jobs:
104103

105104
1. **Checkout Repository**
106105

107-
Checks out your repository code so the workflow can access it.
106+
Checks out thr repository code so the workflow can access it.
108107

109108
```yaml
110109
- uses: actions/checkout@v3
@@ -197,17 +196,7 @@ jobs:
197196
comment: true
198197
```
199198
200-
6. **Optional Debugging Steps**
201199
202-
You can include these steps to list files and display the coverage report for debugging purposes.
203-
204-
```yaml
205-
- name: List workspace files
206-
run: ls -R
207-
208-
- name: Display coverage.xml
209-
run: cat coverage.xml
210-
```
211200
212201
## Project Structure
213202
@@ -226,19 +215,3 @@ your-repository/
226215
└── (Other project files)
227216
```
228217
229-
## Benefits
230-
231-
- **Automated Testing**: Ensures that all code changes are automatically tested.
232-
- **Code Coverage Metrics**: Provides insights into which parts of your codebase are tested.
233-
- **Continuous Integration**: Integrates seamlessly with GitHub Actions for CI/CD workflows.
234-
- **Feedback on Pull Requests**: Codecov can comment on pull requests with coverage reports (requires proper setup and permissions).
235-
236-
## License
237-
238-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
239-
240-
---
241-
242-
**Note**: Ensure that your repository has the Codecov GitHub App installed and configured with the necessary permissions to post comments on pull requests. For private repositories, make sure your Codecov account has access to the repository and that the `CODECOV_TOKEN` is correctly set up in your GitHub repository secrets.
243-
244-
If you encounter issues with Codecov not posting comments on pull requests, refer to the [Codecov documentation](https://docs.codecov.com/docs) or contact [Codecov support](https://community.codecov.io/) for assistance.

0 commit comments

Comments
 (0)