You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
55
55
# Codecov-cli Commands
56
56
| Command | Description |
57
57
| :---: | :---: |
58
-
| `create-commit` | Saves the commit's metadata in codecov, it's only necessry to run this once per commit
58
+
| `create-commit` | Saves the commit's metadata in codecov, it's only necessary to run this once per commit
59
59
| `create-report` | Creates an empty report in codecov with initial data e.g. report name, report's commit
60
60
| `do-upload` | Searches for and uploads coverage data to codecov
61
61
| `create-report-results` | Used for local upload. It tells codecov that you finished local uploading and want it to calculate the results for you to get them locally.
@@ -161,7 +161,7 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
161
161
If desired, the CLI can be used as a replacement for our [NodeJS Binary Uploader](https://github.com/codecov/uploader). To use the CLI to upload from your CI workflow, you need to add these commands:
162
162
163
163
```
164
-
pip install codecovcli
164
+
pip install codecov-cli
165
165
codecovcli create-commit
166
166
codecovcli create-report
167
167
codecovcli do-upload
@@ -175,7 +175,7 @@ The CLI also supports "dry run" local uploading. This is useful if you prefer to
The C code shouldn't require anything additional setup to get running, but depending on your enviroment, you may be prompted to install compilers and supporting tools. If errors are generating during installation, it is likely due to missing dependencies / tools required of the C code. In many cases, resulting error messages should be clear enough to determine what is missing and how to install it, but common errors will be collected here as they are encountered.
219
+
The C code shouldn't require any additional setup to get running, but depending on your environment, you may be prompted to install compilers and supporting tools. If errors are generated during installation, it is likely due to missing dependencies / tools required of the C code. In many cases, resulting error messages should be clear enough to determine what is missing and how to install it, but common errors will be collected here as they are encountered.
220
220
221
221
## Guidelines
222
222
223
-
There are a few guidelines when developing in this systems. Some notable folders:
223
+
There are a few guidelines when developing in this system. Some notable folders:
224
224
225
225
1.`commands` - It's the folder that interacts with the caller. This is where the commands themselves should reside. These commands are not meant to do heavy lifting. They only do wiring, which is mostly parsing the input parameters.
226
-
2.`services` - It's where the heavy logic resides. It's mostly organizaed by which command needs them. Commands should generally be thin wrappers around these services.
227
-
3.`helpers` - This is meant for logic that is useful accross different commands. For example, logging helpers, or the logic the searches folders.
226
+
2.`services` - It's where the heavy logic resides. It's mostly organized by which command needs them. Commands should generally be thin wrappers around these services.
227
+
3.`helpers` - This is meant for logic that is useful across different commands. For example, logging helpers, or the logic that searches folders.
0 commit comments