forked from nasa/cFS
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fb2968d
commit f097f06
Showing
2 changed files
with
64 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Our Workflows | ||
|
|
||
| ## Deprecated Build, Test, and Run | ||
| [](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml) | ||
|
|
||
| This action builds, tests, and runs the cFS bundle using deprecated code. The flag OMIT_DEPRECATED is set to false. For more information on the OMIT_DEPRECATED flag, see [global_build_options.cmake](https://github.com/nasa/cFE/blob/063b4d8a9c4a7e822af5f3e4017599159b985bb0/cmake/sample_defs/global_build_options.cmake). | ||
|
|
||
| Build, Test, and Run runs for every push and every pull request on all branches of cFS in Github Actions. | ||
|
|
||
| ## Build, Test, and Run [OMIT_DEPRECATED=true] | ||
| [](https://github.com/nasa/cfs/actions/workflows/build-cfs.yml) | ||
|
|
||
| This action builds, tests, and runs the cFS bundle omitting deprecated code. | ||
|
|
||
| Build, Test, and Run [OMIT_DEPRECATED=true] runs for every push and every pull request on all branches of cFS in Github Actions. For more information on the OMIT_DEPRECATED flag, see [global_build_options.cmake](https://github.com/nasa/cFE/blob/063b4d8a9c4a7e822af5f3e4017599159b985bb0/cmake/sample_defs/global_build_options.cmake). | ||
|
|
||
| ## CodeQL Analysis | ||
| [](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml) | ||
|
|
||
| This action runs GitHub's static analysis engine, CodeQL, against our repository's source code to find security vulnerabilities. It then automatically uploads the results to GitHub so they can be displayed in the repository's code scanning alerts found under the security tab. CodeQL runs an extensible set of [queries](https://github.com/github/codeql), which have been developed by the community and the [GitHub Security Lab](https://securitylab.github.com/) to find common vulnerabilities in your code. | ||
|
|
||
| CodeQL runs for every push and pull-request on all branches of cFS in GitHub Actions. | ||
|
|
||
| For the CodeQL GitHub Actions setup, visit https://github.com/github/codeql-action. | ||
|
|
||
| Our CodeQL action uses a configuration file to use specific queries, which can be found at [.github/codeql](https://github.com/nasa/cFS/tree/main/.github/codeql). | ||
|
|
||
| ## Static Analaysis | ||
| [](https://github.com/nasa/cfs/actions/workflows/static-analysis.yml) | ||
|
|
||
| This action runs a static analysis tool for C/C++ code known as cppcheck. Cppcheck is designed to be able to analyze C/C++ code even if it has non-standard syntax, which is common in embedded projects. | ||
|
|
||
| The cFS Cppcheck GitHub Actions workflow and results are available to the public. To view the results, select a workflow and download the artifacts. | ||
|
|
||
| Cppcheck runs for every push on the main branch and every pull request on all branches of cFS in Github Actions. | ||
|
|
||
| For more information about Cppcheck, visit http://cppcheck.sourceforge.net/. | ||
|
|
||
| ## Local Unit Test | ||
| [](https://github.com/nasa/osal/actions/workflows/local_unit_test.yml) | ||
|
|
||
| This action tests our code using GCC's coverage testing tool gcov. | ||
|
|
||
| Local Unit Test runs for every push and every pull request on all branches of cFS in Github Actions. | ||
|
|
||
| ## Documentation and Guides | ||
| [](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml) | ||
|
|
||
| This action creates doxygen documents for cFE, cFS users guide, and osal guide. | ||
|
|
||
| Documentation and Guides runs for every push and every pull request on all branches of cFS in Github Actions. The workflow pushes the PDFs for every push on the main branch found at https://github.com/nasa/cfs/tree/gh-pages. | ||
|
|
||
| ## Changelog | ||
| [](https://github.com/nasa/cfs/actions/workflows/changelog.yml) | ||
|
|
||
| This action creates a changelog file which documents all the issues in cFS. | ||
|
|
||
| The Changelog action runs manually. | ||
|
|
||
| ## Format Check | ||
| [](https://github.com/nasa/osal/actions/workflows/format-check.yml) | ||
|
|
||
| This action uses [clang-format-10](https://github.com/nasa/cFS/blob/main/.clang-format) to check for format errors. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters