Skip to content

Commit c0fc953

Browse files
astrogecoastrogeco
authored
Merge pull request #297 from nasa/integration-candidate
cFS bundle Integration candidate: 2021-07-13
2 parents 985d3ac + b38bf85 commit c0fc953

File tree

5 files changed

+86
-53
lines changed

5 files changed

+86
-53
lines changed

‎.github/workflows/README.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Our Workflows
2+
3+
## Deprecated Build, Test, and Run
4+
[![Deprecated Build, Test, and Run](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml)
5+
6+
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).
7+
8+
Build, Test, and Run runs for every push and every pull request on all branches of cFS in Github Actions.
9+
10+
## Build, Test, and Run [OMIT_DEPRECATED=true]
11+
[![Build, Test, and Run %5B OMIT_DEPRECATED=true %5B](https://github.com/nasa/cfs/actions/workflows/build-cfs.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-cfs.yml)
12+
13+
This action builds, tests, and runs the cFS bundle omitting deprecated code.
14+
15+
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).
16+
17+
## CodeQL Analysis
18+
[![CodeQL Analaysis](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml)
19+
20+
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.
21+
22+
CodeQL runs for every push and pull-request on all branches of cFS in GitHub Actions.
23+
24+
For the CodeQL GitHub Actions setup, visit https://github.com/github/codeql-action.
25+
26+
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).
27+
28+
## Static Analaysis
29+
[![Static Analaysis](https://github.com/nasa/cfs/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/static-analysis.yml)
30+
31+
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.
32+
33+
The cFS Cppcheck GitHub Actions workflow and results are available to the public. To view the results, select a workflow and download the artifacts.
34+
35+
Cppcheck runs for every push on the main branch and every pull request on all branches of cFS in Github Actions.
36+
37+
For more information about Cppcheck, visit http://cppcheck.sourceforge.net/.
38+
39+
## Local Unit Test
40+
[![Local Unit Test](https://github.com/nasa/osal/actions/workflows/local_unit_test.yml/badge.svg)](https://github.com/nasa/osal/actions/workflows/local_unit_test.yml)
41+
42+
This action tests our code using GCC's coverage testing tool gcov.
43+
44+
Local Unit Test runs for every push and every pull request on all branches of cFS in Github Actions.
45+
46+
## Documentation and Guides
47+
[![Documentation and Guides](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml)
48+
49+
This action creates doxygen documents for cFE, cFS users guide, and osal guide.
50+
51+
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.
52+
53+
## Changelog
54+
[![Changelog](https://github.com/nasa/cfs/actions/workflows/changelog.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/changelog.yml)
55+
56+
This action creates a changelog file which documents all the issues in cFS.
57+
58+
The Changelog action runs manually.
59+
60+
## Format Check
61+
[![Format Check](https://github.com/nasa/osal/actions/workflows/format-check.yml/badge.svg)](https://github.com/nasa/osal/actions/workflows/format-check.yml)
62+
63+
This action uses [clang-format-10](https://github.com/nasa/cFS/blob/main/.clang-format) to check for format errors.

‎.github/workflows/build-documentation.yml‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ jobs:
7171
fi
7272
7373
build-usersguide:
74-
# Name the Job
7574
needs: checks-for-duplicates
7675
if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }}
76+
# Name the Job
7777
name: Users Guide
7878
# Set the type of machine to run on
7979
runs-on: ubuntu-18.04
@@ -92,7 +92,7 @@ jobs:
9292
cp ./cfe/cmake/Makefile.sample Makefile
9393
cp -r ./cfe/cmake/sample_defs sample_defs
9494
95-
# Setup the build system
95+
# Setup the build system
9696
- name: Make Prep
9797
run: make prep
9898

@@ -112,7 +112,6 @@ jobs:
112112
make_usersguide_stderr.txt
113113
cfe-usersguide-warnings.log
114114
115-
116115
- name: Error Check
117116
run: |
118117
if [[ -s make_usersguide_stderr.txt ]]; then
@@ -127,6 +126,15 @@ jobs:
127126
exit -1
128127
fi
129128
129+
pdf-usersguide:
130+
needs: build-usersguide
131+
# Name the Job
132+
name: PDF Users Guide
133+
# Set the type of machine to run on
134+
runs-on: ubuntu-18.04
135+
136+
steps:
137+
130138
- name: PDF generation installs
131139
if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}}
132140
run: |
@@ -154,9 +162,9 @@ jobs:
154162
SINGLE_COMMIT: true
155163

156164
build-osalguide:
157-
# Name the Job
158165
needs: checks-for-duplicates
159166
if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }}
167+
# Name the Job
160168
name: Osal Guide
161169
# Set the type of machine to run on
162170
runs-on: ubuntu-18.04
@@ -175,7 +183,7 @@ jobs:
175183
cp ./cfe/cmake/Makefile.sample Makefile
176184
cp -r ./cfe/cmake/sample_defs sample_defs
177185
178-
# Setup the build system
186+
# Setup the build system
179187
- name: Make Prep
180188
run: make prep
181189

@@ -187,7 +195,6 @@ jobs:
187195
make osalguide > make_osalguide_stdout.txt 2> make_osalguide_stderr.txt
188196
mv build/docs/osalguide/osal-apiguide-warnings.log osal-apiguide-warnings.log
189197
190-
191198
- name: Archive Osal Guide Build Logs
192199
uses: actions/upload-artifact@v2
193200
with:
@@ -197,7 +204,6 @@ jobs:
197204
make_osalguide_stderr.txt
198205
osal-apiguide-warnings.log
199206
200-
201207
- name: Error Check
202208
run: |
203209
if [[ -s make_osalguide_stderr.txt ]]; then
@@ -212,6 +218,13 @@ jobs:
212218
exit -1
213219
fi
214220
221+
pdf-osalguide:
222+
needs: build-osalguide
223+
# Name the Job
224+
name: PDF Osal Guide
225+
# Set the type of machine to run on
226+
runs-on: ubuntu-18.04
227+
steps:
215228
- name: PDF generation installs
216229
if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}}
217230
run: |

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -277,50 +277,7 @@ or
277277

278278
#### Our Workflows
279279

280-
Additional information on our GitHub Action Workflows can be found in our [Security Policy](https://github.com/nasa/cFS/security/policy).
281-
282-
##### Format Check
283-
[![Format Check](https://github.com/nasa/osal/actions/workflows/format-check.yml/badge.svg)](https://github.com/nasa/osal/actions/workflows/format-check.yml)
284-
285-
This action uses clang-format-10 to check for format errors.
286-
287-
##### CodeQL Analysis
288-
[![CodeQL Analaysis](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml)
289-
290-
This action runs GitHub's industry-leading 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.
291-
292-
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).
293-
294-
295-
##### Static Analaysis
296-
[![Static Analaysis](https://github.com/nasa/cfs/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/static-analysis.yml)
297-
298-
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.
299-
300-
##### Deprecated Build, Test, and Run
301-
[![Deprecated Build, Test, and Run](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml)
302-
303-
This action builds, tests, and runs the cFS bundle using deprecated code.
304-
305-
##### Build, Test, and Run [OMIT_DEPRECATED=true]
306-
[![Build, Test, and Run %5B OMIT_DEPRECATED=true %5B](https://github.com/nasa/cfs/actions/workflows/build-cfs.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-cfs.yml)
307-
308-
This action builds, tests, and runs the cFS bundle omitting deprecated code.
309-
310-
##### Documentation and Guides
311-
[![Documentation and Guides](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml)
312-
313-
This action creates doxygen documents for cFE, cFS users guide, and osal guide.
314-
315-
##### Changelog
316-
[![Changelog](https://github.com/nasa/cfs/actions/workflows/changelog.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/changelog.yml)
317-
318-
This action creates a changelog file which documents all the issues in cFS.
319-
320-
##### Local Unit Test
321-
[![Local Unit Test](https://github.com/nasa/osal/actions/workflows/local_unit_test.yml/badge.svg)](https://github.com/nasa/osal/actions/workflows/local_unit_test.yml)
322-
323-
This action tests our code using GCC's coverage testing tool gcov.
280+
Information on our GitHub Action Workflows can be found in the [.github/workflows README.md](https://github.com/nasa/cFS/tree/main/.github/workflows/README.md) document.
324281

325282
## Quick Links to Submodules
326283
Before you [report bugs](#report-bugs) or submit [feature requests](#feature-requests), search through the open issues in each submodule to ensure that your ticket is relevant, not redundant, nor in conflict with other tickets:

‎cfe‎

‎osal‎

0 commit comments

Comments
 (0)