Create codeql.yml

[canstralian]

Summary by Sourcery

CI:

• Add a CodeQL analysis workflow to scan code for vulnerabilities on push to main, on pull requests targeting main, and on a weekly schedule.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new CodeQL workflow file that enables static analysis for Javascript and Typescript. The workflow is triggered on push and pull requests to the main branch, as well as on a weekly schedule. It sets up the necessary environment, including Python and dependencies, and then runs the CodeQL analysis.

Flow diagram of the CodeQL workflow

flowchart TD
    Start[Trigger] --> Conditions{Trigger Type}
    Conditions -->|Push| Main[Push to main]
    Conditions -->|PR| PR[Pull Request to main]
    Conditions -->|Schedule| Schedule[Weekly Schedule]
    Main --> Checkout[Checkout Repository]
    PR --> Checkout
    Schedule --> Checkout
    Checkout --> SetupPython[Setup Python 3.8]
    SetupPython --> Cache[Cache pip dependencies]
    Cache --> InstallDeps[Install Dependencies]
    InstallDeps --> InitCodeQL[Initialize CodeQL]
    InitCodeQL --> Analysis[Perform CodeQL Analysis]
    Analysis --> End[End]

Loading

File-Level Changes

Change	Details	Files
Creation of the CodeQL workflow file.	Added a new workflow file for CodeQL analysis. Configured the workflow to run on push, pull request, and schedule triggers. Set up a matrix strategy to analyze Javascript and Typescript. Configured the workflow to checkout the repository. Set up Python and install dependencies. Initialized CodeQL with the specified languages and build mode. Added a placeholder for manual build steps. Performed CodeQL analysis.	.github/workflows/codeql.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @canstralian - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider removing the Python setup and pip installation steps since they're not being used for JavaScript/TypeScript analysis
• Update actions/setup-python and actions/cache to v3 to stay current with latest versions

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (performance): Consider updating the action versions and Python version to more recent releases

setup-python@v4, cache@v3, and a more recent Python version (e.g., 3.11) are available and would provide better security and performance benefits.

Suggested change

	uses: actions/setup-python@v2
	with:
	python-version: '3.8'
	- name: Cache pip
	uses: actions/cache@v2
	uses: actions/setup-python@v4
	with:
	python-version: '3.11'
	- name: Cache pip
	uses: actions/cache@v3

[sourcery-ai]

issue (bug_risk): The exit 1 command in the manual build section could cause unexpected failures if manual build mode is enabled

Consider removing the exit 1 and leaving just the echo commands as placeholders, or adding a clear comment that this section needs to be replaced before enabling manual build mode.