Skip to content
Snippets Groups Projects
Commit e19107eb authored by Justin Wood's avatar Justin Wood
Browse files

Aligning tasks & Docks

parent 88c84260
No related branches found
No related tags found
No related merge requests found
...@@ -11,31 +11,43 @@ ...@@ -11,31 +11,43 @@
} }
}, },
{ {
"label": "Pretty", "label": "Auto-enforce coding style",
"type": "shell",
"command": "make -f Makefile-Standalone pretty-check",
"group": "none"
},
{
"label": "Verify coding style conformance",
"type": "shell", "type": "shell",
"command": "make -f Makefile-Standalone pretty", "command": "make -f Makefile-Standalone pretty",
"group": "none" "group": "none"
}, },
{ {
"label": "Test & Check", "label": "Run Unit and Functional Tests",
"type": "shell", "type": "shell",
"command": "make -f Makefile-Standalone check", "command": "make -f Makefile-Standalone check",
"group": "none" "group": "none"
}, },
{ {
"label": "Dist Check", "label": "Run Distribution Generation",
"type": "shell", "type": "shell",
"command": "make -f Makefile-Standalone distcheck", "command": "make -f Makefile-Standalone distcheck",
"group": "none" "group": "none"
}, },
{ {
"label": "Clean", "label": "Run Code Coverage",
"type": "shell",
"command": "make -f Makefile-Standalone coverage",
"group": "none"
},
{
"label": "Clean build",
"type": "shell", "type": "shell",
"command": "make -f Makefile-Standalone clean", "command": "make -f Makefile-Standalone clean",
"group": "none" "group": "none"
}, },
{ {
"label": "Bootstrap", "label": "Bootstrap the source tree",
"type": "shell", "type": "shell",
"command": "./bootstrap", "command": "./bootstrap",
"group": "none" "group": "none"
......
...@@ -45,12 +45,6 @@ The CHIP repository is structured as follows: ...@@ -45,12 +45,6 @@ The CHIP repository is structured as follows:
| `third_party/` | Third-party code used by CHIP.| | `third_party/` | Third-party code used by CHIP.|
| `tools/` | Tools needed to work with the CHIP repo, as well as develop in the repository | | `tools/` | Tools needed to work with the CHIP repo, as well as develop in the repository |
# Third Party Tools
Some tools and utilities are dependent on third party tools, such as Docker.
[Docker](https://www.docker.com) is an excellent way to have stable build environments that don't pollute the host OS. It is also much easier to maintain stability across multiple host environments. Install stable version of [Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to your native OS (MacOS or Windows). Once installed, you can run docker commands from the shell/terminal.
# Contributing # Contributing
We would love for you to contribute to CHIP and help make it even We would love for you to contribute to CHIP and help make it even
......
...@@ -14,3 +14,9 @@ ...@@ -14,3 +14,9 @@
* Documentation about style is documented in [the style guide](./STYLE_GUIDE.md) * Documentation about style is documented in [the style guide](./STYLE_GUIDE.md)
* Additional documentation about more specific files are in the [style folder](./style/) * Additional documentation about more specific files are in the [style folder](./style/)
## Third Party Tools
Some tools and utilities are dependent on third party tools, such as Docker.
[Docker](https://www.docker.com) is an excellent way to have stable build environments that don't pollute the host OS. It is also much easier to maintain stability across multiple host environments. Install stable version of [Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to your native OS (MacOS or Windows). Once installed, you can run docker commands from the shell/terminal.
...@@ -31,3 +31,22 @@ Tested on: ...@@ -31,3 +31,22 @@ Tested on:
Located in the [tasks json](../.vscode/tasks.json) file you'll find a list of tasks that can be run from the "Run Task..." command. Located in the [tasks json](../.vscode/tasks.json) file you'll find a list of tasks that can be run from the "Run Task..." command.
Example tasks are "Clean", "Run Pretty Check" Example tasks are "Clean", "Run Pretty Check"
Developers are encouraged to add tasks to the [tasks json](../.vscode/tasks.json) over time to make sure everyone is using the same base configuration and build.
### Current base tasks are listed here
* Main Build - Full build and test of the tree
* Auto-enforce coding style
* Verify coding style conformance
* Run Unit and Functional Tests
* Run Distribution Generation - Build and check distribution, running all functional and unit tests
* Run Code Coverage (via 'make coverage')
* Clean build - Full clean build and test of the tree
* Bootstrap the source tree - On a clean tree, pull in the third party dependencies required
* Clean Tree - Full (and destructive) git clean of the tree
## Launch Tasks
Located in the [launch json](../.vscode/launch.json) file you'll find a list of build & run jobs that can be run from the "Run" tab and start a run or debug session.
Developers are encouraged to add tasks to the [launch json](../.vscode/launch.json) over time to make sure everyone is using the same base debuging setup.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment