Skip to content

chore: harden GitHub collaboration and security automation - #5

Merged
mkarson1997 merged 1 commit into
mainfrom
chore/github-hardening
Sep 4, 2026
Merged

chore: harden GitHub collaboration and security automation#5
mkarson1997 merged 1 commit into
mainfrom
chore/github-hardening

Conversation

@mkarson1997

@mkarson1997 mkarson1997 commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Adds ownership rules, a reliability-focused PR checklist, Dependabot coverage for npm and GitHub Actions, and CodeQL analysis for the TypeScript runtime. Existing issue forms are preserved.

Summary by Sourcery

Harden repository collaboration and security automation with ownership guidance, reliability checks, dependency updates, and CodeQL scanning.

Enhancements:

  • Establish repository ownership and a reliability-focused pull request checklist.
  • Add automated dependency update coverage for npm packages and GitHub Actions.
  • Enable scheduled and change-triggered CodeQL analysis for the TypeScript runtime.

CI:

  • Add CodeQL security analysis workflow for JavaScript/TypeScript changes.

Copilot AI lite review requested due to automatic review settings September 4, 2026 14:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sourcery-ai

sourcery-ai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Reviewer's Guide

Hardens GitHub collaboration and security automation by adding ownership and reliability review guidance, weekly Dependabot coverage for npm and Actions, and least-privilege CodeQL analysis for JavaScript/TypeScript changes.

File-Level Changes

Change Details Files
Adds repository ownership and a standardized reliability-focused pull request workflow.
  • Defines code ownership rules for GitHub-managed files.
  • Adds checklists covering reliability, compatibility, observability, validation, and secret hygiene.
  • Preserves the existing issue forms while introducing the pull request template.
.github/CODEOWNERS
.github/PULL_REQUEST_TEMPLATE.md
Configures automated dependency update coverage for project and GitHub Actions dependencies.
  • Schedules weekly npm updates with a limit of five open pull requests.
  • Groups npm development-dependency updates.
  • Schedules weekly GitHub Actions updates with the same pull request limit.
.github/dependabot.yml
Introduces scheduled and change-triggered CodeQL analysis for the TypeScript runtime.
  • Runs analysis on main-branch pushes, main-targeted pull requests, and a weekly schedule.
  • Uses the JavaScript/TypeScript CodeQL language configuration on Ubuntu.
  • Grants read access to repository contents and write access to security events, with a 15-minute job timeout.
.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!

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

@sonarqubecloud

sonarqubecloud Bot commented Sep 4, 2026

Copy link
Copy Markdown

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path=".github/workflows/codeql.yml" line_range="22" />
<code_context>
+    timeout-minutes: 15
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
</code_context>
<issue_to_address>
**🚨 issue (security):** The CodeQL workflow executes mutable major-version tags for checkout and both CodeQL actions, so a tag movement or compromised release runs unreviewed action code with `security-events: write` permission.

**Triggers:** When one of the referenced major tags is retagged or its upstream release is compromised.

**Suggested fix:** Pin each action to a reviewed commit SHA and let Dependabot update the SHA references.
</issue_to_address>

Sourcery assessment

Needs a human reviewer. 1 finding to address first, and a mistaken CODEOWNERS policy could block required reviews or let changes proceed under the wrong ownership, while a faulty CodeQL workflow could disable or misconfigure security scanning or fail CI. Reverting restores the prior repository behavior, but merges made or scans missed while the change was active would need separate review or remediation.

Blocking findings: .github/workflows/codeql.yml:22


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

timeout-minutes: 15
steps:
- name: Checkout
uses: actions/checkout@v4

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 issue (security): The CodeQL workflow executes mutable major-version tags for checkout and both CodeQL actions, so a tag movement or compromised release runs unreviewed action code with security-events: write permission.

Triggers: When one of the referenced major tags is retagged or its upstream release is compromised.

Suggested fix: Pin each action to a reviewed commit SHA and let Dependabot update the SHA references.

@mkarson1997
mkarson1997 merged commit b3364dc into main Sep 4, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants