-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from edwardtheharris/33-enable-codeql
33 enable codeql Closes #33
- Loading branch information
Showing
7 changed files
with
256 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| ### | ||
| # ```{rubric} CodeQL Intro | ||
| # ``` | ||
| # --- | ||
| # For most projects, this workflow file will not need changing; you simply need | ||
| # to commit it to your repository. | ||
| # | ||
| # You may wish to alter this file to override the set of languages analyzed, | ||
| # or to provide custom queries or build logic. | ||
| # | ||
| # ```{note} | ||
| # We have attempted to detect the languages in your repository. Please check | ||
| # the `language` matrix defined below to confirm you have the correct set of | ||
| # supported CodeQL languages. | ||
| # ``` | ||
| # | ||
| # ```{literalinclude} ./.github/workflows/codeql.yml | ||
| # :caption: .github/workflows/codeql.yml#name | ||
| # :language: yaml | ||
| # :start-at: "name: CodeQL\n" | ||
| # :end-before: "###\n" | ||
| # ``` | ||
| name: CodeQL | ||
| permissions: | ||
| contents: read | ||
| on: | ||
| push: | ||
| branches: [ "main" ] | ||
| pull_request: | ||
| branches: [ "main" ] | ||
| schedule: | ||
| - cron: '18 22 * * 6' | ||
| ### | ||
| # ```{rubric} CodeQL Jobs | ||
| # ``` | ||
| # --- | ||
| # Define the jobs that run in the CodeQL workflow. | ||
| # | ||
| # ```{literalinclude} ./.github/workflows/codeql.yml | ||
| # :caption: .github/workflows/codeql.yml#jobs | ||
| # :language: yaml | ||
| # :start-at: "jobs:\n" | ||
| # ``` | ||
| jobs: | ||
| analyze: | ||
| name: Analyze | ||
| ### | ||
| # Runner size impacts CodeQL analysis time. | ||
| # ```{note} | ||
| # To learn more, please see: | ||
| # - https://gh.io/recommended-hardware-resources-for-running-codeql | ||
| # - https://gh.io/supported-runners-and-hardware-resources | ||
| # - https://gh.io/using-larger-runners | ||
| # ``` | ||
| # | ||
| # Consider using larger runners for possible analysis time improvements. | ||
| runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} | ||
| timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} | ||
| permissions: | ||
| ### | ||
| # required for all workflows | ||
| security-events: write | ||
| ### | ||
| # only required for workflows in private repositories | ||
| actions: read | ||
| contents: read | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| ### | ||
| # CodeQL supports these languages. | ||
| # - `c-cpp` | ||
| # - `csharp` | ||
| # - `go` | ||
| # - `java-kotlin` | ||
| # - `javascript-typescript` | ||
| # - `python` | ||
| # - `ruby` | ||
| # - `swift` | ||
| # | ||
| # Use only `java-kotlin` to analyze code written in Java, Kotlin or both | ||
| # Use only `javascript-typescript` to analyze code written in | ||
| # JavaScript, TypeScript or both. | ||
| # | ||
| # Learn more about [CodeQL language support](https://aka.ms/codeql-docs/language-support) | ||
| language: [ 'javascript-typescript', 'python' ] | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| ### | ||
| # Initializes the CodeQL tools for scanning. | ||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v3 | ||
| with: | ||
| ### | ||
| # If you wish to specify custom queries, you can do so here or in a config file. | ||
| # By default, queries listed here will override any specified in a config file. | ||
| # Prefix the list here with "+" to use these queries and those in the config file. | ||
| # For more details on CodeQL's query packs, see [here](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs) | ||
| # queries: `security-extended,security-and-quality` | ||
| languages: ${{ matrix.language }} | ||
| ### | ||
| # Autobuild attempts to build any compiled languages | ||
| # (C/C++, C#, Go, Java, or Swift). | ||
| # If this step fails, then you should remove it and run the build | ||
| # manually (see below) | ||
| - name: Autobuild | ||
| uses: github/codeql-action/autobuild@v3 | ||
| ### | ||
| # - ℹ️ Command-line programs to run using the OS shell. | ||
| # - 📚 See [here](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun) | ||
| # - If the Autobuild fails above, remove it and uncomment the following three lines. | ||
| # - modify them (or add more) to build your code if your project, | ||
| # - please refer to the EXAMPLE below for guidance. | ||
| # | ||
| # ```{code-block} yaml | ||
| # - run: | | ||
| # echo "Run, Build Application using script" | ||
| # ./location_of_script_within_repo/buildscript.sh | ||
| # ``` | ||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@v3 | ||
| with: | ||
| category: "/language:${{matrix.language}}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| abstract: API, usage, and other documentation for Panegyric. | ||
| authors: Xander Harris | ||
| date: 2024-03-12 | ||
| title: Panegyric Docs Index | ||
| --- | ||
|
|
||
| ```{toctree} | ||
| modules | ||
| panegyric | ||
| tests | ||
| ``` | ||
|
|
||
| ```{sectionauthor} Xander Harris <[email protected]> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,33 @@ | ||
| .. Panegyric documentation master file, created by | ||
| --- | ||
| abstract: >- | ||
| Panegyric documentation master file, created by | ||
| sphinx-quickstart on Sat Sep 11 11:56:24 2021. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
| authors: Xander Harris | ||
| date: 2024-03-12 | ||
| title: Panegyric Documentation | ||
| --- | ||
|
|
||
| Welcome to Panegyric's documentation! | ||
| ===================================== | ||
| If you feel like complimenting my wife via text, this is a great way to do it. | ||
|
|
||
| This is a tool that allows you to send nice texts once a day. | ||
| ```{toctree} | ||
| :maxdepth: 2 | ||
| :caption: Documentation | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Contents: | ||
| docs/index | ||
| ``` | ||
|
|
||
| modules | ||
| panegyric | ||
| tests | ||
| ```{toctree} | ||
| :caption: Minutiae | ||
| license | ||
| readme | ||
| security | ||
| ``` | ||
|
|
||
| ## Indices and tables | ||
|
|
||
| Indices and tables | ||
| ================== | ||
|
|
||
| * :ref:`genindex` | ||
| * :ref:`modindex` | ||
| * :ref:`search` | ||
| - {ref}`genindex` | ||
| - {ref}`modindex` | ||
| - {ref}`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| abstract: A security policy, one day. | ||
| authors: Xander Harris | ||
| date: 2024-03-13 | ||
| title: Security Policy | ||
| --- | ||
|
|
||
| ## Don't do anything stupid |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| abstract: A security policy, one day. | ||
| authors: Xander Harris | ||
| date: 2024-03-13 | ||
| title: Security Policy | ||
| --- | ||
|
|
||
| ## Don't do anything stupid |