Fix #288, Add Workflow README #292

ArielSAdamsNASA · 2021-07-07T15:01:29Z

Checklist (Please check before submitting)

I reviewed the Contributing Guide.
I signed and emailed the appropriate Contributor License agreement to [email protected] and copied [email protected].

Describe the contribution
Fixes #288
Add a README in .github/workflows

Expected behavior changes
Users will know what each workflow does.

Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal

astrogeco

Looks good, can you fix the headings so that they are second level ## instead?

astrogeco · 2021-07-07T15:05:47Z

.github/workflows/README.md

+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


Embed link to cppcheck

Added

For more information about Cppcheck, visit http://cppcheck.sourceforge.net/.

astrogeco · 2021-07-07T15:06:22Z

.github/workflows/README.md

+##### Deprecated Build, Test, and Run
+[![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)
+
+This action builds, tests, and runs the cFS bundle using deprecated code.


mention the OMIT_DEPRECATED flag and maybe link to the cmake documantation

Where is the cmake documentation?

Linked to global_build_options.cmake

astrogeco · 2021-07-07T15:06:51Z

.github/workflows/README.md

+##### Documentation and Guides
+[![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)
+
+This action creates doxygen documents for cFE, cFS users guide, and osal guide.


maybe add that it also pushes the pdf for pushes to main

Added:

Documentation and Guides is ran 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.

good, we might also want to add the link to where the documentation is pushed to:
https://github.com/nasa/cfs/tree/gh-pages

astrogeco

Some minor comments. We might want to change the order of these and have the build ones up first.

Also, replace the section that covers this in Contributing.md with a link to this new readme

astrogeco · 2021-07-08T19:35:26Z

.github/workflows/README.md

+## Format Check
+[![Format Check](https://github.com/nasa/osal/actions/workflows/format-check.yml/badge.svg)](https://github.com/nasa/osal/actions/workflows/format-check.yml)
+
+This action uses clang-format-10 to check for format errors.


Add link to .clang-format config file

This link https://releases.llvm.org/10.0.0/tools/clang/docs/ClangFormat.html?

Used https://github.com/nasa/cFS/blob/main/.clang-format

astrogeco · 2021-07-08T19:36:02Z

.github/workflows/README.md

+## CodeQL Analysis
+[![CodeQL Analaysis](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml)
+
+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.


remove the "industry leading" part we can't be seen as "endorsing" a product

.github/workflows/README.md

astrogeco · 2021-07-08T19:37:56Z

.github/workflows/README.md

+##### Documentation and Guides
+[![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)
+
+This action creates doxygen documents for cFE, cFS users guide, and osal guide.


good, we might also want to add the link to where the documentation is pushed to:
https://github.com/nasa/cfs/tree/gh-pages

ArielSAdamsNASA added the docs label Jul 7, 2021

ArielSAdamsNASA requested a review from astrogeco July 7, 2021 15:01

ArielSAdamsNASA force-pushed the fix-288-workflows-readme branch from e78927c to 280c4ae Compare July 7, 2021 15:03

astrogeco suggested changes Jul 7, 2021

View reviewed changes

ArielSAdamsNASA force-pushed the fix-288-workflows-readme branch 2 times, most recently from b6d7f85 to 6a25507 Compare July 8, 2021 15:07

astrogeco added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Jul 8, 2021

astrogeco suggested changes Jul 8, 2021

View reviewed changes

ArielSAdamsNASA force-pushed the fix-288-workflows-readme branch 3 times, most recently from ccc9e07 to f097f06 Compare July 8, 2021 23:46

Fix nasa#288, Add Workflows README

c1f981e

ArielSAdamsNASA force-pushed the fix-288-workflows-readme branch from f097f06 to c1f981e Compare July 8, 2021 23:48

astrogeco changed the base branch from main to integration-candidate July 13, 2021 00:45

astrogeco merged commit b38bf85 into nasa:integration-candidate Jul 13, 2021

ArielSAdamsNASA deleted the fix-288-workflows-readme branch July 13, 2021 16:10

astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Jul 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #288, Add Workflow README #292

Fix #288, Add Workflow README #292

ArielSAdamsNASA commented Jul 7, 2021

astrogeco left a comment

astrogeco Jul 7, 2021

ArielSAdamsNASA Jul 7, 2021

astrogeco Jul 7, 2021

ArielSAdamsNASA Jul 7, 2021

ArielSAdamsNASA Jul 8, 2021

astrogeco Jul 7, 2021

ArielSAdamsNASA Jul 7, 2021

astrogeco Jul 8, 2021

astrogeco left a comment

astrogeco Jul 8, 2021

ArielSAdamsNASA Jul 8, 2021

ArielSAdamsNASA Jul 8, 2021

astrogeco Jul 8, 2021

ArielSAdamsNASA Jul 8, 2021

astrogeco Jul 8, 2021

		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

Fix #288, Add Workflow README #292

Fix #288, Add Workflow README #292

Conversation

ArielSAdamsNASA commented Jul 7, 2021

astrogeco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

astrogeco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment