Skip to content

Commit c9652d8

Browse files
authored
chore: add public-repo readiness files (CODEOWNERS, LICENSE, Socket scan) (#4)
* chore: add public-repo readiness files 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) * ci: harden the Socket scan workflow 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. * style: move packageManager to oxfmt's canonical position 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.
1 parent 7616f5e commit c9652d8

5 files changed

Lines changed: 118 additions & 0 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# See GitHub's docs for more details:
2+
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
3+
4+
# DX Team
5+
* @workos/dx
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
28+
- OS: [e.g. macOS 15.5, Windows 11]
29+
- authkit-electron version [e.g. 0.1.0]
30+
- Electron version [e.g. 37.2.0]
31+
- Sign-in ceremony [system-browser or window]
32+
33+
**Additional context**
34+
Add any other context about the problem here.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Socket Tier 1 Reachability Analysis
2+
3+
on:
4+
schedule:
5+
# every day at 12 AM
6+
- cron: '0 0 * * *'
7+
workflow_dispatch:
8+
inputs:
9+
tags:
10+
description: 'Manually run vulnerability analysis'
11+
distinct_id:
12+
description: 'Required by the return-dispatch action'
13+
required: true
14+
15+
concurrency:
16+
group: ${{ github.workflow }}-${{ github.ref_name }}
17+
cancel-in-progress: true
18+
19+
permissions:
20+
contents: read
21+
22+
jobs:
23+
socket-vulnerability-analysis:
24+
runs-on: ubuntu-latest
25+
timeout-minutes: 60
26+
27+
steps:
28+
- name: Check distinct_id
29+
env:
30+
DISTINCT_ID: ${{ github.event.inputs.distinct_id }}
31+
run: |
32+
echo "distinct_id: $DISTINCT_ID"
33+
- name: Checkout code
34+
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
35+
- name: Install Socket CLI
36+
# Pinned so a compromised release can't run arbitrary code next to
37+
# SOCKET_SECURITY_API_TOKEN; bump deliberately.
38+
run: npm install -g socket@1.1.145
39+
- name: Run Tier 1 reachability scan
40+
env:
41+
SOCKET_SECURITY_API_TOKEN: ${{ secrets.SOCKET_API_KEY }}
42+
run: |
43+
# Full application reachability (Tier 1)
44+
socket scan create . \
45+
--reach \
46+
--org "workos" \
47+
--no-interactive

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 WorkOS
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -530,3 +530,14 @@ A complete, runnable Electron app consuming this SDK lives in [`example/`](./exa
530530

531531
- [WorkOS AuthKit docs](https://workos.com/docs/user-management)
532532
- [`@workos/authkit-session`](https://www.npmjs.com/package/@workos/authkit-session) — the framework-agnostic core this library builds on
533+
534+
## Contributing
535+
536+
Issues and pull requests are welcome. Before opening a PR:
537+
538+
- Run `pnpm lint`, `pnpm typecheck`, and `pnpm test` — CI enforces all three.
539+
- Use a [conventional commit](https://www.conventionalcommits.org/) PR title (e.g. `fix: ...`, `feat: ...`); releases are cut automatically from them via release-please.
540+
541+
## License
542+
543+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)