Skip to content

Commit 09de7cf

Browse files
committed
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.
1 parent fa02f82 commit 09de7cf

File tree

8 files changed

+35
-3
lines changed

8 files changed

+35
-3
lines changed

docs/codeql/codeql-overview/codeql-tools.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ The standard CodeQL query and library packs
2323
(`source <https://github.com/github/codeql/tree/codeql-cli/latest>`__)
2424
maintained by GitHub are:
2525

26+
- ``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>`__)
27+
- ``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>`__)
2628
- ``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>`__)
2729
- ``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>`__)
2830
- ``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>`__)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- `CodeQL queries for GitHub Actions <https://github.com/github/codeql/tree/main/actions/ql/src>`__
2+
- `CodeQL library reference for GitHub Actions <https://codeql.github.com/codeql-standard-libraries/actions/>`__

docs/codeql/reusables/extractors.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
* - Language
66
- Identifier
7+
* - GitHub Actions
8+
- ``actions``
79
* - C/C++
810
- ``cpp``
911
* - C#

docs/codeql/reusables/supported-frameworks.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,23 @@ and the CodeQL library pack ``codeql/csharp-all`` (`changelog <https://github.co
4040
NHibernate, Database ORM
4141
WinForms, User interface
4242

43+
GitHub Actions built-in support
44+
================================
45+
46+
Provided by the current versions of the
47+
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>`__)
48+
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>`__).
49+
50+
.. csv-table::
51+
:header-rows: 1
52+
:class: fullWidthTable
53+
:widths: auto
54+
:align: left
55+
56+
Name, Category
57+
`GitHub Actions workflow YAML files <https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions>`, Workflows
58+
`GitHub Actions action metadata YAML files <https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions>`, Actions
59+
4360
Go built-in support
4461
================================
4562

docs/codeql/reusables/supported-versions-compilers.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
.NET Core up to 3.1
1717

1818
.NET 5, .NET 6, .NET 7, .NET 8, .NET 9","``.sln``, ``.csproj``, ``.cs``, ``.cshtml``, ``.xaml``"
19+
GitHub Actions [12]_,"Not applicable",Not applicable,"``.github/workflows/*.yml``, ``.github/workflows/*.yaml``, ``action.yml``, ``action.yaml``"
1920
Go (aka Golang), "Go up to 1.24", "Go 1.11 or more recent", ``.go``
2021
Java,"Java 7 to 24 [5]_","javac (OpenJDK and Oracle JDK),
2122

@@ -40,3 +41,4 @@
4041
.. [9] Requires glibc 2.17.
4142
.. [10] Support for the analysis of Swift requires macOS.
4243
.. [11] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default.
44+
.. [12] Support for GitHub Actions is in public preview.

docs/codeql/writing-codeql-queries/about-codeql-queries.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ When writing your own alert queries, you would typically import the standard lib
7474
- :ref:`CodeQL library guide for C and C++ <codeql-library-for-cpp>`
7575
- :ref:`CodeQL library guide for C# <codeql-library-for-csharp>`
7676
- :ref:`CodeQL library guide for Go <codeql-library-for-go>`
77+
- :ref:`CodeQL library guide for GitHub Actions <codeql-library-for-actions>`
7778
- :ref:`CodeQL library guide for Java and Kotlin <codeql-library-for-java>`
7879
- :ref:`CodeQL library guide for JavaScript <codeql-library-for-javascript>`
7980
- :ref:`CodeQL library guide for Python <codeql-library-for-python>`

docs/query-help-style-guide.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ When you contribute a new [supported query](supported-queries.md) to this reposi
77
* [C/C++ queries](https://codeql.github.com/codeql-query-help/cpp/)
88
* [C# queries](https://codeql.github.com/codeql-query-help/csharp/)
99
* [Go queries](https://codeql.github.com/codeql-query-help/go/)
10-
* [Java queries](https://codeql.github.com/codeql-query-help/java/)
11-
* [JavaScript queries](https://codeql.github.com/codeql-query-help/javascript/)
10+
* [GitHub Actions queries](https://codeql.github.com/codeql-query-help/actions/)
11+
* [Java/Kotlin queries](https://codeql.github.com/codeql-query-help/java/)
12+
* [JavaScript/TypeScript queries](https://codeql.github.com/codeql-query-help/javascript/)
1213
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
14+
* [Ruby queries](https://codeql.github.com/codeql-query-help/ruby/)
15+
* [Swift queries](https://codeql.github.com/codeql-query-help/swift/)
1316

1417
### Location and file name
1518

docs/query-metadata-style-guide.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@ For examples of query files for the languages supported by CodeQL, visit the fol
1919

2020
* [C/C++ queries](https://codeql.github.com/codeql-query-help/cpp/)
2121
* [C# queries](https://codeql.github.com/codeql-query-help/csharp/)
22+
* [GitHub Actions queries](https://codeql.github.com/codeql-query-help/actions/)
2223
* [Go queries](https://codeql.github.com/codeql-query-help/go/)
23-
* [Java queries](https://codeql.github.com/codeql-query-help/java/)
24+
* [Java/Kotlin queries](https://codeql.github.com/codeql-query-help/java/)
2425
* [JavaScript queries](https://codeql.github.com/codeql-query-help/javascript/)
2526
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
27+
* [Ruby queries](https://codeql.github.com/codeql-query-help/ruby/)
28+
* [Swift queries](https://codeql.github.com/codeql-query-help/swift/)
2629

2730
## Metadata area
2831

0 commit comments

Comments
 (0)