From b6d7f85509e4575cfe52205b57ac136ebef69739 Mon Sep 17 00:00:00 2001
From: ArielSAdams <63608107+ArielSAdams@users.noreply.github.com>
Date: Wed, 7 Jul 2021 09:59:18 -0500
Subject: [PATCH] Fix #288, Add Workflows README

---
 .github/workflows/README.md | 63 +++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 .github/workflows/README.md

diff --git a/.github/workflows/README.md b/.github/workflows/README.md
new file mode 100644
index 000000000..9446bfac9
--- /dev/null
+++ b/.github/workflows/README.md
@@ -0,0 +1,63 @@
+# Our Workflows
+
+## 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.
+
+## 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.
+
+CodeQL is ran 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
+[![Static Analaysis](https://github.com/nasa/cfs/actions/workflows/static-analysis.yml/badge.svg)](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 is ran 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/.
+
+## 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. The flag OMIT_DEPRECATED is set to false.
+
+Build, Test, and Run is ran for every push and every pull request on all branches of cFS in Github Actions.
+
+## Build, Test, and Run [OMIT_DEPRECATED=true]
+[![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)
+
+This action builds, tests, and runs the cFS bundle omitting deprecated code.
+
+Build, Test, and Run [OMIT_DEPRECATED=true] is ran for every push and every pull request on all branches of cFS in Github Actions.
+
+## 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.
+
+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. 
+
+## Changelog
+[![Changelog](https://github.com/nasa/cfs/actions/workflows/changelog.yml/badge.svg)](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 is ran manually. 
+
+## Local Unit Test
+[![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)
+
+This action tests our code using GCC's coverage testing tool gcov.
+
+Local Unit Test is ran for every push and every pull request on all branches of cFS in Github Actions.