-
Notifications
You must be signed in to change notification settings - Fork 233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix #288, Add Workflow README #292
Merged
astrogeco
merged 1 commit into
nasa:integration-candidate
from
ArielSAdamsNASA:fix-288-workflows-readme
Jul 13, 2021
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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. The PDFs can be 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add that it also pushes the pdf for pushes to
mainThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good, we might also want to add the link to where the documentation is pushed to:
https://github.com/nasa/cfs/tree/gh-pages