Repository navigation
feat: add draft-segment-schema-pr action - #294
Open
NicolasMassart wants to merge 9 commits into
Open
NicolasMassart wants to merge 9 commits into
NicolasMassart wants to merge 9 commits into
Conversation
Open a Consensys/segment-schema draft from Mobile or Extension analytics diffs after the PR author agrees, using the GitHub API for the client file list. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
All alerts resolved. Learn more about Socket for GitHub. This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. Ignoring alerts on:
|
Contributor
Author
|
@SocketSecurity ignore npm/yaml@2.9.0 official parser; we only call parseDocument(text), no reviver/onAnchor. |
This was referenced Oct 6, 2026
NicolasMassart
requested review from
Mrtenz and
jvbriones
and
a balanced review from Copilot
and removed request for
Mrtenz
October 6, 2026 14:42
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Analytics detection, YAML generation, comment ownership, and existing branch updates contain correctness and reliability issues.
Review effort: Balanced
Findings: 1
Open (11)
What changed in this PR
Adds a reusable composite action that detects Mobile/Extension analytics changes and manages draft Segment schema PRs.
Changes:
- Adds analytics extraction, schema generation, and GitHub publishing.
- Adds gating for proposal, creation, update, and closure workflows.
- Adds tests, documentation, dependencies, and lint/coverage configuration.
| File | Description |
|---|---|
yarn.lock |
Locks the YAML dependency. |
src/segment-schema-draft-pr/types.ts |
Defines action data models. |
src/segment-schema-draft-pr/schema-index.ts |
Indexes existing schema YAML. |
src/segment-schema-draft-pr/publish.ts |
Publishes comments and schema PRs. |
src/segment-schema-draft-pr/publish.test.ts |
Tests publishing behavior. |
src/segment-schema-draft-pr/pr-body.ts |
Renders proposal and PR text. |
src/segment-schema-draft-pr/pr-body.test.ts |
Tests rendered text and splicing. |
src/segment-schema-draft-pr/parse-args.ts |
Parses CLI arguments. |
src/segment-schema-draft-pr/parse-args.test.ts |
Tests argument parsing. |
src/segment-schema-draft-pr/names.ts |
Normalizes schema names. |
src/segment-schema-draft-pr/names.test.ts |
Tests name normalization. |
src/segment-schema-draft-pr/github-output.ts |
Writes action outputs. |
src/segment-schema-draft-pr/github-output.test.ts |
Tests output writing. |
src/segment-schema-draft-pr/github-api.ts |
Wraps GitHub API operations. |
src/segment-schema-draft-pr/github-api.test.ts |
Tests GitHub API helpers. |
src/segment-schema-draft-pr/generate.ts |
Orchestrates schema generation. |
src/segment-schema-draft-pr/generate.test.ts |
Tests end-to-end generation. |
src/segment-schema-draft-pr/diff-models.ts |
Computes analytics changesets. |
src/segment-schema-draft-pr/diff-models.test.ts |
Tests changeset calculation. |
src/segment-schema-draft-pr/constants.ts |
Defines shared action constants. |
src/segment-schema-draft-pr/config.ts |
Defines platform configuration. |
src/segment-schema-draft-pr/config.test.ts |
Tests platform configuration. |
src/segment-schema-draft-pr/client-diff.ts |
Reads PR TypeScript diffs. |
src/segment-schema-draft-pr/client-diff.test.ts |
Tests PR diff handling. |
src/segment-schema-draft-pr/cli.ts |
Provides the action CLI entrypoint. |
src/segment-schema-draft-pr/apply-changes.ts |
Creates and updates schema YAML. |
src/segment-schema-draft-pr/apply-changes.test.ts |
Tests schema mutations. |
src/segment-schema-draft-pr/analytics-model.ts |
Extracts analytics from TypeScript. |
src/segment-schema-draft-pr/analytics-model.test.ts |
Tests analytics extraction. |
src/env-utils.ts |
Exposes process environment access. |
src/env-utils.test.ts |
Tests environment helpers. |
README.md |
Documents action usage and workflows. |
package.json |
Adds scripts, YAML, and action tests. |
jest.config.js |
Raises coverage thresholds. |
CHANGELOG.md |
Records the new action. |
.github/actions/draft-segment-schema-pr/gate.test.mjs |
Tests pre-install gating. |
.github/actions/draft-segment-schema-pr/gate.mjs |
Implements pre-install gating. |
.github/actions/draft-segment-schema-pr/action.yml |
Defines the composite action. |
.eslintrc.js |
Adds linting for action modules. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…ema draft action - Increased coverage thresholds for branches, functions, lines, and statements in jest.config.js. - Improved README.md to clarify the usage of the Segment schema draft CLI. - Modified the draft-segment-schema-pr action to ensure proper fetching of remote branches and handle analytics hits more accurately. - Updated various functions to correctly count and manage TypeScript file changes, including handling renamed files and ensuring unique event paths in the schema. - Added tests to validate new functionality and ensure existing behavior remains intact.
Prettier rejects the unaligned markdown table in CI. Co-authored-by: Cursor <cursoragent@cursor.com>
The github-script client replaces Authorization, so schema reads need their own client. Co-authored-by: Cursor <cursoragent@cursor.com>
Declaring getOctokit again throws because github-script already injects it. Co-authored-by: Cursor <cursoragent@cursor.com>
Publish called GET /user, and the workflow token rejects that request. Co-authored-by: Cursor <cursoragent@cursor.com>
NicolasMassart
marked this pull request as ready for review
October 15, 2026 12:10
Callers re-read the client pull request under the write lock before minting the App token. Co-authored-by: Cursor <cursoragent@cursor.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
draft-segment-schema-prcomposite action that reads Mobile/Extension analytics diffs through the GitHub API, comments one proposal, and opens a draftConsensys/segment-schemaPR after the author commentsI agree to open a draft Segment schema PR.pulls.listFiles(three-dot PR comparison). Schema YAML is still committed and pushed with git. Helper, not a merge gate.@v1exists.fixes MCWP-575
See also platform implementation PRs:
Test plan
yarn testandyarn linton this branchproposeposts or edits a single sticky proposal comment and does not comment on PRs with no analytics changescreateopens a draft schema PR only after the author agreement comment on an open, same-repo PRproposeruns update the same bot branch when a schema PR is already openclosecloses the schema PR when the client PR closes unmerged, and leaves it open when mergedScreenshots
Extension PR:
Mobile PR:
