You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Discovered in internal review of docs preview.
Use double backticks to render inline code blocks.
Use __ after inline hyperlinks.
Use an extra blank line to format the Actions library predicates table correctly.
Fix some rogue references to Ruby and case inconsistency.
Copy file name to clipboardExpand all lines: docs/codeql/codeql-language-guides/codeql-for-actions.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,6 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
12
12
codeql-library-for-actions
13
13
customizing-library-models-for-actions
14
14
15
-
- :doc:`CodeQL library for GitHub Actions <codeql-library-for-actions>`: When you're analyzing a Ruby program, you can make use of the large collection of classes in the CodeQL library for GitHub Actions.
15
+
- :doc:`CodeQL library for GitHub Actions <codeql-library-for-actions>`: When you're analyzing GitHub Actions code, you can make use of the large collection of classes in the CodeQL library for GitHub Actions.
16
16
17
17
- :doc:`Customizing library models for GitHub Actions <customizing-library-models-for-actions>`: You can model frameworks and libraries that your codebase depends on using data extensions and publish them as CodeQL model packs.
Copy file name to clipboardExpand all lines: docs/codeql/codeql-language-guides/codeql-library-for-actions.rst
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ to all AST classes:
95
95
* - ``getAChildNode()``
96
96
- Gets a child node of this node.
97
97
* - ``getParentNode()``
98
-
- Gets the parent of this `AstNode`, if this node is not a root node.
98
+
- Gets the parent of this ``AstNode``, if this node is not a root node.
99
99
* - ``getATriggerEvent()``
100
100
- Gets an Actions trigger event that can start the enclosing Actions workflow, if any.
101
101
@@ -104,9 +104,9 @@ Workflows
104
104
~~~~~~~~~
105
105
106
106
A workflow is a configurable automated process made up of one or more jobs,
107
-
defined in a workflow YAML file in the `.github/workflows` directory of a GitHub repository.
107
+
defined in a workflow YAML file in the ``.github/workflows`` directory of a GitHub repository.
108
108
109
-
In the CodeQL AST library, a `Workflow` is an `AstNode` representing the mapping at the top level of an Actions YAML workflow file.
109
+
In the CodeQL AST library, a ``Workflow`` is an ``AstNode`` representing the mapping at the top level of an Actions YAML workflow file.
110
110
111
111
See the GitHub Actions documentation on `workflows <https://docs.github.com/en/actions/writing-workflows/about-workflows>`__ and `workflow syntax <https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions>`__ for more information.
112
112
@@ -116,16 +116,17 @@ See the GitHub Actions documentation on `workflows <https://docs.github.com/en/a
116
116
* - CodeQL class
117
117
- Description and selected predicates
118
118
* - ``Workflow``
119
-
- An Actions workflow, defined as a mapping at the top level of a workflow YAML file in `.github/workflows`. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions.
120
-
- `getAJob()` - Gets a job within the `jobs` mapping of this workflow.
121
-
- `getEnv()` - Gets an `env` mapping within this workflow declaring workflow-level environment variables, if any.
122
-
- `getJob(string jobId)` - Gets a job within the `jobs` mapping of this workflow with the given job ID.
123
-
- `getOn()` - Gets the `on` mapping defining the events that trigger this workflow.
124
-
- `getPermissions()` - Gets a `permissions` mapping within this workflow declaring workflow-level token permissions, if any.
125
-
- `getStrategy()` - Gets a `strategy` mapping for the jobs in this workflow, if any.
126
-
- `getName()` - Gets the name of this workflow, if defined within the workflow.
127
-
128
-
The following example lists all jobs in a workflow with the name declaration `name: test`:
119
+
- An Actions workflow, defined as a mapping at the top level of a workflow YAML file in ``.github/workflows``. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions.
120
+
121
+
- ``getAJob()`` - Gets a job within the ``jobs`` mapping of this workflow.
122
+
- ``getEnv()`` - Gets an ``env`` mapping within this workflow declaring workflow-level environment variables, if any.
123
+
- ``getJob(string jobId)`` - Gets a job within the ``jobs`` mapping of this workflow with the given job ID.
124
+
- ``getOn()``` - Gets the ``on`` mapping defining the events that trigger this workflow.
125
+
- ``getPermissions()`` - Gets a ``permissions`` mapping within this workflow declaring workflow-level token permissions, if any.
126
+
- ``getStrategy()``` - Gets a ``strategy`` mapping for the jobs in this workflow, if any.
127
+
- ``getName()`` - Gets the name of this workflow, if defined within the workflow.
128
+
129
+
The following example lists all jobs in a workflow with the name declaration ``name: test``:
0 commit comments