FilesExpand file tree

main

/

generate-query-help-docs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

60 lines (57 loc) · 1.86 KB

main

/

generate-query-help-docs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

60 lines (57 loc) · 1.86 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

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