mirror of
https://github.com/github/codeql.git
synced 2025-12-28 14:46:33 +01:00
61 lines
1.9 KiB
YAML
61 lines
1.9 KiB
YAML
name: Generate CodeQL query help documentation using Sphinx
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
description:
|
|
description: A description of the purpose of this job. For human consumption.
|
|
required: false
|
|
push:
|
|
branches:
|
|
- 'lgtm.com'
|
|
pull_request:
|
|
paths:
|
|
- '.github/workflows/generate-query-help-docs.yml'
|
|
- 'docs/codeql/query-help/**'
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Clone github/codeql
|
|
uses: actions/checkout@v2
|
|
with:
|
|
path: codeql
|
|
- name: Clone github/codeql-go
|
|
uses: actions/checkout@v2
|
|
with:
|
|
repository: 'github/codeql-go'
|
|
path: codeql-go
|
|
- name: Set up Python 3.8
|
|
uses: actions/setup-python@v2
|
|
with:
|
|
python-version: 3.8
|
|
- name: Download CodeQL CLI
|
|
uses: dsaltares/fetch-gh-release-asset@aa37ae5c44d3c9820bc12fe675e8670ecd93bd1c
|
|
with:
|
|
repo: "github/codeql-cli-binaries"
|
|
version: "latest"
|
|
file: "codeql-linux64.zip"
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
- name: Unzip CodeQL CLI
|
|
run: unzip -d codeql-cli codeql-linux64.zip
|
|
- name: Set up query help docs folder
|
|
run: |
|
|
cp -r codeql/docs/codeql/** .
|
|
- name: Query help to markdown
|
|
run: |
|
|
PATH="$PATH:codeql-cli/codeql" python codeql/docs/codeql/query-help-markdown.py
|
|
- name: Run Sphinx for query help
|
|
uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2 # v0.4
|
|
with:
|
|
docs-folder: "query-help/"
|
|
pre-build-command: "python -m pip install --upgrade recommonmark && python -m pip install --upgrade sphinx-markdown-tables"
|
|
build-command: "sphinx-build -b dirhtml . _build"
|
|
- name: Upload HTML artifacts
|
|
uses: actions/upload-artifact@v2
|
|
with:
|
|
name: query-help-html
|
|
path: query-help/_build
|
|
|