mirror of
https://github.com/github/codeql.git
synced 2025-12-17 01:03:14 +01:00
Docs: Add GitHub Actions as a supported language
Include GitHub Actions (identifier `actions`) everywhere we list supported languages, query packs, and library packs. Query and library documentation link targets do not exist yet.
This commit is contained in:
@@ -23,6 +23,8 @@ The standard CodeQL query and library packs
|
|||||||
(`source <https://github.com/github/codeql/tree/codeql-cli/latest>`__)
|
(`source <https://github.com/github/codeql/tree/codeql-cli/latest>`__)
|
||||||
maintained by GitHub are:
|
maintained by GitHub are:
|
||||||
|
|
||||||
|
- ``codeql/actions-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/actions/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/actions/ql/src>`__)
|
||||||
|
- ``codeql/actions-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/actions/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/actions/ql/lib>`__)
|
||||||
- ``codeql/cpp-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src>`__)
|
- ``codeql/cpp-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src>`__)
|
||||||
- ``codeql/cpp-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib>`__)
|
- ``codeql/cpp-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib>`__)
|
||||||
- ``codeql/csharp-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/src>`__)
|
- ``codeql/csharp-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/src>`__)
|
||||||
|
|||||||
2
docs/codeql/reusables/actions-further-reading.rst
Normal file
2
docs/codeql/reusables/actions-further-reading.rst
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
- `CodeQL queries for GitHub Actions <https://github.com/github/codeql/tree/main/actions/ql/src>`__
|
||||||
|
- `CodeQL library reference for GitHub Actions <https://codeql.github.com/codeql-standard-libraries/actions/>`__
|
||||||
@@ -4,6 +4,8 @@
|
|||||||
|
|
||||||
* - Language
|
* - Language
|
||||||
- Identifier
|
- Identifier
|
||||||
|
* - GitHub Actions
|
||||||
|
- ``actions``
|
||||||
* - C/C++
|
* - C/C++
|
||||||
- ``cpp``
|
- ``cpp``
|
||||||
* - C#
|
* - C#
|
||||||
|
|||||||
@@ -40,6 +40,23 @@ and the CodeQL library pack ``codeql/csharp-all`` (`changelog <https://github.co
|
|||||||
NHibernate, Database ORM
|
NHibernate, Database ORM
|
||||||
WinForms, User interface
|
WinForms, User interface
|
||||||
|
|
||||||
|
GitHub Actions built-in support
|
||||||
|
================================
|
||||||
|
|
||||||
|
Provided by the current versions of the
|
||||||
|
CodeQL query pack ``codeql/actions-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/actions/ql/src>`__)
|
||||||
|
and the CodeQL library pack ``codeql/actions-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/actions/ql/lib>`__).
|
||||||
|
|
||||||
|
.. csv-table::
|
||||||
|
:header-rows: 1
|
||||||
|
:class: fullWidthTable
|
||||||
|
:widths: auto
|
||||||
|
:align: left
|
||||||
|
|
||||||
|
Name, Category
|
||||||
|
`GitHub Actions workflow YAML files <https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions>`, Workflows
|
||||||
|
`GitHub Actions action metadata YAML files <https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions>`, Actions
|
||||||
|
|
||||||
Go built-in support
|
Go built-in support
|
||||||
================================
|
================================
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@
|
|||||||
.NET Core up to 3.1
|
.NET Core up to 3.1
|
||||||
|
|
||||||
.NET 5, .NET 6, .NET 7, .NET 8, .NET 9","``.sln``, ``.csproj``, ``.cs``, ``.cshtml``, ``.xaml``"
|
.NET 5, .NET 6, .NET 7, .NET 8, .NET 9","``.sln``, ``.csproj``, ``.cs``, ``.cshtml``, ``.xaml``"
|
||||||
|
GitHub Actions [12]_,"Not applicable",Not applicable,"``.github/workflows/*.yml``, ``.github/workflows/*.yaml``, ``action.yml``, ``action.yaml``"
|
||||||
Go (aka Golang), "Go up to 1.24", "Go 1.11 or more recent", ``.go``
|
Go (aka Golang), "Go up to 1.24", "Go 1.11 or more recent", ``.go``
|
||||||
Java,"Java 7 to 24 [5]_","javac (OpenJDK and Oracle JDK),
|
Java,"Java 7 to 24 [5]_","javac (OpenJDK and Oracle JDK),
|
||||||
|
|
||||||
@@ -40,3 +41,4 @@
|
|||||||
.. [9] Requires glibc 2.17.
|
.. [9] Requires glibc 2.17.
|
||||||
.. [10] Support for the analysis of Swift requires macOS.
|
.. [10] Support for the analysis of Swift requires macOS.
|
||||||
.. [11] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default.
|
.. [11] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default.
|
||||||
|
.. [12] Support for GitHub Actions is in public preview.
|
||||||
|
|||||||
@@ -74,6 +74,7 @@ When writing your own alert queries, you would typically import the standard lib
|
|||||||
- :ref:`CodeQL library guide for C and C++ <codeql-library-for-cpp>`
|
- :ref:`CodeQL library guide for C and C++ <codeql-library-for-cpp>`
|
||||||
- :ref:`CodeQL library guide for C# <codeql-library-for-csharp>`
|
- :ref:`CodeQL library guide for C# <codeql-library-for-csharp>`
|
||||||
- :ref:`CodeQL library guide for Go <codeql-library-for-go>`
|
- :ref:`CodeQL library guide for Go <codeql-library-for-go>`
|
||||||
|
- :ref:`CodeQL library guide for GitHub Actions <codeql-library-for-actions>`
|
||||||
- :ref:`CodeQL library guide for Java and Kotlin <codeql-library-for-java>`
|
- :ref:`CodeQL library guide for Java and Kotlin <codeql-library-for-java>`
|
||||||
- :ref:`CodeQL library guide for JavaScript <codeql-library-for-javascript>`
|
- :ref:`CodeQL library guide for JavaScript <codeql-library-for-javascript>`
|
||||||
- :ref:`CodeQL library guide for Python <codeql-library-for-python>`
|
- :ref:`CodeQL library guide for Python <codeql-library-for-python>`
|
||||||
|
|||||||
@@ -7,9 +7,12 @@ When you contribute a new [supported query](supported-queries.md) to this reposi
|
|||||||
* [C/C++ queries](https://codeql.github.com/codeql-query-help/cpp/)
|
* [C/C++ queries](https://codeql.github.com/codeql-query-help/cpp/)
|
||||||
* [C# queries](https://codeql.github.com/codeql-query-help/csharp/)
|
* [C# queries](https://codeql.github.com/codeql-query-help/csharp/)
|
||||||
* [Go queries](https://codeql.github.com/codeql-query-help/go/)
|
* [Go queries](https://codeql.github.com/codeql-query-help/go/)
|
||||||
* [Java queries](https://codeql.github.com/codeql-query-help/java/)
|
* [GitHub Actions queries](https://codeql.github.com/codeql-query-help/actions/)
|
||||||
* [JavaScript queries](https://codeql.github.com/codeql-query-help/javascript/)
|
* [Java/Kotlin queries](https://codeql.github.com/codeql-query-help/java/)
|
||||||
|
* [JavaScript/TypeScript queries](https://codeql.github.com/codeql-query-help/javascript/)
|
||||||
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
|
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
|
||||||
|
* [Ruby queries](https://codeql.github.com/codeql-query-help/ruby/)
|
||||||
|
* [Swift queries](https://codeql.github.com/codeql-query-help/swift/)
|
||||||
|
|
||||||
### Location and file name
|
### Location and file name
|
||||||
|
|
||||||
|
|||||||
@@ -19,10 +19,13 @@ For examples of query files for the languages supported by CodeQL, visit the fol
|
|||||||
|
|
||||||
* [C/C++ queries](https://codeql.github.com/codeql-query-help/cpp/)
|
* [C/C++ queries](https://codeql.github.com/codeql-query-help/cpp/)
|
||||||
* [C# queries](https://codeql.github.com/codeql-query-help/csharp/)
|
* [C# queries](https://codeql.github.com/codeql-query-help/csharp/)
|
||||||
|
* [GitHub Actions queries](https://codeql.github.com/codeql-query-help/actions/)
|
||||||
* [Go queries](https://codeql.github.com/codeql-query-help/go/)
|
* [Go queries](https://codeql.github.com/codeql-query-help/go/)
|
||||||
* [Java queries](https://codeql.github.com/codeql-query-help/java/)
|
* [Java/Kotlin queries](https://codeql.github.com/codeql-query-help/java/)
|
||||||
* [JavaScript queries](https://codeql.github.com/codeql-query-help/javascript/)
|
* [JavaScript queries](https://codeql.github.com/codeql-query-help/javascript/)
|
||||||
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
|
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
|
||||||
|
* [Ruby queries](https://codeql.github.com/codeql-query-help/ruby/)
|
||||||
|
* [Swift queries](https://codeql.github.com/codeql-query-help/swift/)
|
||||||
|
|
||||||
## Metadata area
|
## Metadata area
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user