snapshot of https://github.com/yjs/yjs.git @ 96c96e1fcb1ef6ce866d5264b3f97f7f77b11f64 (2026-09-15)
This commit is contained in:
2
.github/FUNDING.yml
vendored
Normal file
2
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
github: dmonad
|
||||
open_collective: y-collective
|
||||
90
.github/INCIDENT_RESPONSE.md
vendored
Normal file
90
.github/INCIDENT_RESPONSE.md
vendored
Normal file
@@ -0,0 +1,90 @@
|
||||
# Incident Response Plan
|
||||
|
||||
How Yjs maintainers handle security incidents. This plan is designed for small teams.
|
||||
|
||||
---
|
||||
|
||||
## 1. Receive a Private Disclosure
|
||||
|
||||
All security issues should be reported privately via the method described in [`SECURITY.md`](../SECURITY.md) (GitHub Security Advisory). Lower-severity issues can be filed as regular issues.
|
||||
|
||||
**Target:** Acknowledge receipt within 3 business days.
|
||||
|
||||
---
|
||||
|
||||
## 2. Triage
|
||||
|
||||
Assess severity:
|
||||
|
||||
| Severity | Example | Target |
|
||||
|----------|---------|--------|
|
||||
| **Critical** | Arbitrary code execution, compromised release | Acknowledge < 24h, fix < 7d |
|
||||
| **High** | Data leakage, denial of service on shared docs | Acknowledge < 3d, fix < 14d |
|
||||
| **Medium** | Edge-case corruption under unusual conditions | Fix in next release |
|
||||
| **Low** | Informational, no direct user risk | Fix as scheduled |
|
||||
|
||||
These are good-faith targets for a volunteer-maintained project, not SLAs.
|
||||
|
||||
---
|
||||
|
||||
## 3. Contain & Fix
|
||||
|
||||
1. **Open a private GitHub Security Advisory** for the issue if one doesn't already exist.
|
||||
2. **Develop the fix** in the advisory's private fork to avoid leaking details.
|
||||
3. **Assign a CVE** through GitHub's advisory flow before publishing.
|
||||
4. **Yank affected releases from npm** (`npm deprecate` with a message pointing to the advisory) if the severity is Critical or High.
|
||||
5. **Publish the patched release** to npm.
|
||||
6. **Update the version support matrix** in `SECURITY.md`.
|
||||
|
||||
---
|
||||
|
||||
## 4. Disclose
|
||||
|
||||
After the fix is published:
|
||||
|
||||
1. **Publish the GitHub Security Advisory** with:
|
||||
- What happened
|
||||
- Which versions are affected
|
||||
- How users can update or mitigate
|
||||
- The assigned CVE
|
||||
2. **Notify sponsors** via the appropriate channel (email, GitHub Sponsors update, or OpenCollective post).
|
||||
3. **Post to GitHub Discussions** for broader community awareness, linking to the advisory.
|
||||
|
||||
Responsible disclosure principles:
|
||||
- Never publish details before a fix is available.
|
||||
- Never name reporters without their consent.
|
||||
- Coordinate embargo periods with downstream consumers (e.g., major framework integrations) when needed.
|
||||
|
||||
---
|
||||
|
||||
## 5. Post-Incident
|
||||
|
||||
Within one week of resolution:
|
||||
|
||||
- Note what happened, what worked, and what to improve (can be a short section in the advisory itself or a comment on the discussion post).
|
||||
- Update this plan if the process broke down anywhere.
|
||||
|
||||
---
|
||||
|
||||
## 6. Checklist (quick reference)
|
||||
|
||||
```
|
||||
[ ] Private report received & acknowledged
|
||||
[ ] Severity assessed
|
||||
[ ] Private advisory + fork created on GitHub
|
||||
[ ] Fix developed & tested
|
||||
[ ] CVE assigned
|
||||
[ ] Affected npm versions deprecated (if Critical/High)
|
||||
[ ] Patched release published
|
||||
[ ] SECURITY.md version matrix updated
|
||||
[ ] Advisory published
|
||||
[ ] Sponsors notified
|
||||
[ ] Community notified (Discussions)
|
||||
[ ] Post-incident notes written
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Plan Maintenance
|
||||
|
||||
Review this plan once a year or after any incident. Changes are tracked in git history.
|
||||
34
.github/workflows/node.js.yml
vendored
Normal file
34
.github/workflows/node.js.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
|
||||
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
|
||||
|
||||
name: Node.js CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [26.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- run: npm ci
|
||||
- run: npm run lint
|
||||
- run: npm run test
|
||||
env:
|
||||
CI: true
|
||||
70
.github/workflows/publish.yml
vendored
Normal file
70
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,70 @@
|
||||
name: Publish to npm
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: ["Node.js CI"]
|
||||
types: [completed]
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
check:
|
||||
if: github.event.workflow_run.conclusion == 'success'
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
outputs:
|
||||
should_publish: ${{ steps.version-check.outputs.should_publish }}
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 26.x
|
||||
- name: Check if version is already published
|
||||
id: version-check
|
||||
run: |
|
||||
NAME=$(node -p "require('./package.json').name")
|
||||
LOCAL=$(node -p "require('./package.json').version")
|
||||
if npm view "${NAME}@${LOCAL}" version 2>/dev/null; then
|
||||
echo "should_publish=false" >> "$GITHUB_OUTPUT"
|
||||
echo "Version $LOCAL already published, skipping."
|
||||
else
|
||||
echo "should_publish=true" >> "$GITHUB_OUTPUT"
|
||||
echo "New version detected: $LOCAL"
|
||||
fi
|
||||
|
||||
publish:
|
||||
needs: check
|
||||
if: needs.check.outputs.should_publish == 'true'
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 26.x
|
||||
- run: npm ci
|
||||
- name: Build
|
||||
run: npm run dist
|
||||
- name: Determine npm tag
|
||||
id: npm-tag
|
||||
run: |
|
||||
VERSION=$(node -p "require('./package.json').version")
|
||||
if [[ "$VERSION" == *-* ]]; then
|
||||
echo "tag=beta" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "tag=latest" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
- name: Publish
|
||||
run: npm publish --provenance --access public --tag ${{ steps.npm-tag.outputs.tag }}
|
||||
- name: Create GitHub Release
|
||||
run: |
|
||||
VERSION=$(node -p "require('./package.json').version")
|
||||
PRERELEASE=""
|
||||
if [[ "$VERSION" == *-* ]]; then
|
||||
PRERELEASE="--prerelease"
|
||||
fi
|
||||
gh release create "v${VERSION}" --generate-notes $PRERELEASE
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
78
.github/workflows/scorecard.yml
vendored
Normal file
78
.github/workflows/scorecard.yml
vendored
Normal file
@@ -0,0 +1,78 @@
|
||||
# This workflow uses actions that are not certified by GitHub. They are provided
|
||||
# by a third-party and are governed by separate terms of service, privacy
|
||||
# policy, and support documentation.
|
||||
|
||||
name: Scorecard supply-chain security
|
||||
on:
|
||||
# For Branch-Protection check. Only the default branch is supported. See
|
||||
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
|
||||
branch_protection_rule:
|
||||
# To guarantee Maintained check is occasionally updated. See
|
||||
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
|
||||
schedule:
|
||||
- cron: '28 5 * * 0'
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
|
||||
# Declare default permissions as read only.
|
||||
permissions: read-all
|
||||
|
||||
jobs:
|
||||
analysis:
|
||||
name: Scorecard analysis
|
||||
runs-on: ubuntu-latest
|
||||
# `publish_results: true` only works when run from the default branch. conditional can be removed if disabled.
|
||||
if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request'
|
||||
permissions:
|
||||
# Needed to upload the results to code-scanning dashboard.
|
||||
security-events: write
|
||||
# Needed to publish results and get a badge (see publish_results below).
|
||||
id-token: write
|
||||
# Uncomment the permissions below if installing in a private repository.
|
||||
# contents: read
|
||||
# actions: read
|
||||
|
||||
steps:
|
||||
- name: "Checkout code"
|
||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Run analysis"
|
||||
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
|
||||
with:
|
||||
results_file: results.sarif
|
||||
results_format: sarif
|
||||
# (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
|
||||
# - you want to enable the Branch-Protection check on a *public* repository, or
|
||||
# - you are installing Scorecard on a *private* repository
|
||||
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
|
||||
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
|
||||
|
||||
# Public repositories:
|
||||
# - Publish results to OpenSSF REST API for easy access by consumers
|
||||
# - Allows the repository to include the Scorecard badge.
|
||||
# - See https://github.com/ossf/scorecard-action#publishing-results.
|
||||
# For private repositories:
|
||||
# - `publish_results` will always be set to `false`, regardless
|
||||
# of the value entered here.
|
||||
publish_results: true
|
||||
|
||||
# (Optional) Uncomment file_mode if you have a .gitattributes with files marked export-ignore
|
||||
# file_mode: git
|
||||
|
||||
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
|
||||
# format to the repository Actions tab.
|
||||
- name: "Upload artifact"
|
||||
uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
|
||||
with:
|
||||
name: SARIF file
|
||||
path: results.sarif
|
||||
retention-days: 5
|
||||
|
||||
# Upload the results to GitHub's code scanning dashboard (optional).
|
||||
# Commenting out will disable upload of results to your repo's Code Scanning dashboard
|
||||
- name: "Upload to code-scanning"
|
||||
uses: github/codeql-action/upload-sarif@v3
|
||||
with:
|
||||
sarif_file: results.sarif
|
||||
Reference in New Issue
Block a user