From ffae259e9e09acc27c4be6c748e335f42cd1924e Mon Sep 17 00:00:00 2001 From: kumvijaya Date: Wed, 8 May 2024 14:06:39 +0530 Subject: T6315: added reusable codeql workflow documentation --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) (limited to 'README.md') 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 + + + +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 + + + + + +| **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** | + + +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) -- cgit v1.2.3 From fcdc636e107eb7086db5db60b85b1041b09d1ee6 Mon Sep 17 00:00:00 2001 From: kumvijaya Date: Wed, 8 May 2024 14:12:15 +0530 Subject: T6315: added reusable codeql workflow documentation --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 430987e..74e1b92 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,6 @@ jobs: 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 - - @@ -56,7 +48,7 @@ jobs: | ---------------------- | ---------------------------------------------------------------------------------------------- | ---------------| ------------- | | **`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** | +| **`build-command`** | Manual build command. The multiline syntax is supported | | **false** | Referenece: -- cgit v1.2.3 From 6e6b3310bf5e293ff3879ca2d2cda31dea9c35cd Mon Sep 17 00:00:00 2001 From: kumvijaya Date: Wed, 8 May 2024 14:13:52 +0530 Subject: T6315: added reusable codeql workflow documentation --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 74e1b92..285369a 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ This keeps all the reusable github action workflows for vyos -**codeql-analysis**: -This performs codeql analysis on the invoking repo using given inputs. +## codeql-analysis ## + +This reusable workflow performs codeql analysis on the invoking repo using given inputs. This performs below: -- cgit v1.2.3