Skip to content

chore: add public-repo readiness files (CODEOWNERS, LICENSE, Socket scan) - #4

Merged
nicknisi merged 3 commits into
mainfrom
chore/public-repo-readiness
Jul 24, 2026
Merged

nicknisi merged 3 commits into
mainfrom
chore/public-repo-readiness

Conversation

@nicknisi

Copy link
Copy Markdown
Member

Prerequisites for making this repo public, per the How we ship public-facing repositories runbook and the request in #authkit Slack. Everything mirrors the public authkit-nextjs repo:

  • .github/CODEOWNERS — * @workos/dx
  • LICENSE — MIT (package.json already declared MIT but the file was missing)
  • .github/workflows/socket-tier1-analysis.yml — daily Socket Tier 1 vulnerability scan, copied verbatim (needs the SOCKET_API_KEY repo secret)
  • .github/ISSUE_TEMPLATE/bug_report.md — adapted for Electron (OS / Electron version / sign-in ceremony fields)
  • README.md — adds the runbook-required Contributing and License sections

Not in this PR (repo settings, not code): the main branch-protection ruleset — spec mirroring authkit-nextjs's is in the PR discussion.

@devin-ai-integration devin-ai-integration 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.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@greptile-apps

greptile-apps Bot commented Jul 23, 2026 •

Copy link
Copy Markdown

Greptile Summary

This PR adds the standard public-repository readiness files to authkit-electron, mirroring the pattern used in authkit-nextjs. No functional code is changed.

  • .github/CODEOWNERS assigns @workos/dx as owner for all files; LICENSE adds the MIT text that package.json already declared; README.md appends the runbook-required Contributing and License sections.
  • .github/workflows/socket-tier1-analysis.yml introduces a daily Socket Tier 1 reachability scan; both actions/checkout (SHA-pinned) and the Socket CLI (socket@1.1.145) are locked to explicit versions per the inline comment.
  • package.json cosmetically moves the packageManager field to the end of the object — no functional change.

Confidence Score: 5/5

All changes are configuration and documentation files with no impact on runtime behavior — safe to merge.

Every file added is a repo metadata artifact (CODEOWNERS, LICENSE, issue template, README sections, GitHub Actions workflow). The workflow pins both the checkout action to a commit SHA and the Socket CLI to an exact version, and uses minimal contents: read permissions. No application logic is touched.

No files require special attention.

Important Files Changed

Filename Overview
.github/CODEOWNERS New file assigning all repo files to @workos/dx team as code owners — standard and correct.
.github/ISSUE_TEMPLATE/bug_report.md New bug report template with Electron-specific fields (OS, Electron version, sign-in ceremony) — well-adapted for the SDK.
.github/workflows/socket-tier1-analysis.yml New daily Socket Tier 1 reachability scan; actions/checkout pinned to SHA and Socket CLI pinned to 1.1.145 — both intentionally locked per inline comment.
LICENSE Adds the MIT LICENSE file to match the license: "MIT" declaration already in package.json; copyright year is correct.
README.md Appends Contributing and License sections as required by the public-repo runbook — prose is accurate and consistent with the repo setup.
package.json Moves the packageManager field to the end of the JSON object — purely cosmetic reordering with no functional impact.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([Trigger]) --> B{Event type?}
    B -->|Schedule: daily 00:00 UTC| C[Start job]
    B -->|workflow_dispatch| D{distinct_id provided?}
    D -->|No| E([Skip — required input missing])
    D -->|Yes| C
    C --> F[Echo distinct_id]
    F --> G[Checkout code\nactions/checkout @ SHA]
    G --> H[Install Socket CLI\nsocket@1.1.145]
    H --> I[Run Tier 1 reachability scan\nsocket scan create . --reach --org workos]
    I --> J([Scan results uploaded to Socket])
Loading

Reviews (3): Last reviewed commit: "style: move packageManager to oxfmt's ca..." | Re-trigger Greptile

Comment thread .github/workflows/socket-tier1-analysis.yml
nicknisi added 2 commits July 23, 2026 13:22
Prerequisites for making the repo public per the WorkOS runbook
for shipping public-facing repositories, mirroring authkit-nextjs:

- CODEOWNERS assigning the repo to @workos/dx
- MIT LICENSE plus README License and Contributing sections
- Daily Socket tier-1 vulnerability scan workflow
- Bug report issue template adapted for Electron
  (OS, Electron version, sign-in ceremony)
Security review of the workflow (originally a verbatim copy from
authkit-nextjs) flagged three issues:

- Script injection: distinct_id was interpolated directly into a
  run: block; pass it through the DISTINCT_ID env var instead so
  workflow_dispatch input can't inject shell commands.
- Supply chain: npm install -g socket floated the latest release;
  pin to socket@1.1.145 since the CLI runs adjacent to
  SOCKET_SECURITY_API_TOKEN.
- Excessive permissions: no permissions block meant default token
  grants; add top-level contents: read, as checkout is the only
  GitHub API use.
@nicknisi
nicknisi force-pushed the chore/public-repo-readiness branch from 59190dc to 9581406 Compare July 23, 2026 18:22
PR #3 placed "packageManager" after "description" (matching
authkit-nextjs), but oxfmt sorts package.json keys canonically and wants
it last — so `format:check` fails on main and on every PR's merge ref.
PR #3's own CI caught this but was merged before the check was read.
@nicknisi
nicknisi merged commit c9652d8 into main Jul 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant