commit bf3225af70acdfd269265ad20255c2376925a44f Author: Michael Hohn Date: Thu Nov 21 13:35:09 2024 -0800 initial guides diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..32c3074 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 GitHub + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.org b/README.org new file mode 100644 index 0000000..9d45e63 --- /dev/null +++ b/README.org @@ -0,0 +1,11 @@ +* Visual guide to CodeQL + This repository contains several maps illustrating the pieces involved in CodeQL + deployment and query writing. In particular, the maps try to illustrate the + connections between CI/CD, query development, and query deployment. + +** Using the illustrations + The illustrations are drawn using the open-source https://www.drawio.com/ tool. + PDF exports are provided they can be viewed without downloading any extra + tools. + + diff --git a/codeql-query-development-groups.drawio b/codeql-query-development-groups.drawio new file mode 100644 index 0000000..cd777f2 --- /dev/null +++ b/codeql-query-development-groups.drawio @@ -0,0 +1,86 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/codeql-query-development-groups.drawio.pdf b/codeql-query-development-groups.drawio.pdf new file mode 100644 index 0000000..25c2b7e Binary files /dev/null and b/codeql-query-development-groups.drawio.pdf differ diff --git a/codeql-query-development.drawio b/codeql-query-development.drawio new file mode 100644 index 0000000..fccada7 --- /dev/null +++ b/codeql-query-development.drawio @@ -0,0 +1,121 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/codeql-query-development.drawio.pdf b/codeql-query-development.drawio.pdf new file mode 100644 index 0000000..2a0b248 Binary files /dev/null and b/codeql-query-development.drawio.pdf differ diff --git a/codeql-system.drawio b/codeql-system.drawio new file mode 100644 index 0000000..efca660 --- /dev/null +++ b/codeql-system.drawio @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/codeql-system.drawio.pdf b/codeql-system.drawio.pdf new file mode 100644 index 0000000..0946c9f Binary files /dev/null and b/codeql-system.drawio.pdf differ