Skip to content

Commit 98b6e5c

Browse files
committed
Docs: Fix formatting of GitHub Actions content
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.
1 parent 88439b4 commit 98b6e5c

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

docs/codeql/codeql-language-guides/codeql-for-actions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
1212
codeql-library-for-actions
1313
customizing-library-models-for-actions
1414

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.
1616

1717
- :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.

docs/codeql/codeql-language-guides/codeql-library-for-actions.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ to all AST classes:
9595
* - ``getAChildNode()``
9696
- Gets a child node of this node.
9797
* - ``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.
9999
* - ``getATriggerEvent()``
100100
- Gets an Actions trigger event that can start the enclosing Actions workflow, if any.
101101

@@ -104,9 +104,9 @@ Workflows
104104
~~~~~~~~~
105105

106106
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.
108108

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.
110110

111111
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.
112112

@@ -116,16 +116,17 @@ See the GitHub Actions documentation on `workflows <https://docs.github.com/en/a
116116
* - CodeQL class
117117
- Description and selected predicates
118118
* - ``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``:
129130

130131
.. code-block:: ql
131132

docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _customizing-library-models-for-actions:
22

3-
Customizing Library Models for GitHub Actions
3+
Customizing library models for GitHub Actions
44
=============================================
55

66
.. include:: ../reusables/beta-note-customizing-library-models.rst

docs/codeql/codeql-language-guides/customizing-library-models-for-ruby.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _customizing-library-models-for-ruby:
22

33

4-
Customizing Library Models for Ruby
4+
Customizing library models for Ruby
55
===================================
66

77
.. include:: ../reusables/beta-note-customizing-library-models.rst

docs/codeql/reusables/supported-frameworks.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ and the CodeQL library pack ``codeql/actions-all`` (`changelog <https://github.c
5454
:align: left
5555

5656
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
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
5959

6060
Go built-in support
6161
================================

0 commit comments

Comments
 (0)