T6315: added reusable codeql workflow documentation

1 files changed, 66 insertions, 1 deletions

diff --git a/README.md b/README.md
index c2d3879..430987e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,66 @@
-# vyos-github-actions
\ No newline at end of file
+# vyos-github-actions
+
+<!-- start title -->
+
+This keeps all the reusable github action workflows for vyos
+
+**codeql-analysis**:
+This performs codeql analysis on the invoking repo using given inputs.
+
+This performs below:
+
+- Checkout the code.
+- Initialize codeql. This uses the input languages. Initializes for each language given in input.
+- Build the code. Either using autobuild or manual build as per input.
+- Analyze with codeql.
+
+_Usage_:
+
+```yaml
+name: "Perform CodeQL Analysis"
+
+on:
+  push:
+    branches: [ "current", "sagitta", "equuleus" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "current" ]
+  schedule:
+    - cron: '22 10 * * 0'
+
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
+jobs:
+  codeql-analysis-call:
+    uses: vyos/vyos-github-actions/.github/workflows/codeql-analysis.yml@main
+    secrets: inherit
+    with:
+      languages: "['python']"
+```
+
+
+**Inputs**:
+
+- _languages_: Optional input , 'typescript', 'python', 'ruby'. To set multiple languages, use the same syntax as you can see in the default value.
+- _codeql-cfg-path_: Optional input to set path to a CodeQL config file.
+- _build-command_: Optional input to specify manual build command. The multiline syntax is supported
+
+
+<!-- end usage -->
+<!-- start inputs -->
+
+| **Input**              | **Description**                                                                                | **Default**    | **Required**  |
+| ---------------------- | ---------------------------------------------------------------------------------------------- | ---------------| ------------- |
+| **`languages`**        | Languages for CodeQL check. Supported values are: 'cpp', 'csharp', 'go', 'java', 'javascript'  | **['python']** | **false**     |
+| **`codeql-cfg-path`**  | Path to a CodeQL config file                                                                   |                | **false**     |
+| **`build-command`**    | Manual build command                                                                           |                | **false**     |
+
+<!-- end inputs -->
+Referenece:
+[Codeql Action](https://github.com/github/codeql-action)
+
+
+Also see the [GitHub reusable workflows documentation](https://docs.github.com/en/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository)