chore: document open-core model + parity manifest + CI warning#19
Open
govindkavaturi-art wants to merge 1 commit intomainfrom
Open
chore: document open-core model + parity manifest + CI warning#19govindkavaturi-art wants to merge 1 commit intomainfrom
govindkavaturi-art wants to merge 1 commit intomainfrom
Conversation
Adds the open-core policy doc, a manifest of files that should stay in sync with the private cueapi monorepo, and a GitHub Action that posts a soft-enforcement comment on PRs which touch tracked files. Contents: - HOSTED_ONLY.md: which features are OSS, which are hosted-only, and why. Table covers Stripe billing, GDPR endpoints, blog pipeline, memory blocks, support ticket routing, Jenny docs chatbot, deploy hook, dashboard UI, and email alert delivery (SendGrid). Includes a 'Contributing a port' section for community-driven moves from hosted to OSS. - parity-manifest.json: 60 files across alembic, app/core, middleware, models, routers, schemas, services, utils that have a same-path counterpart in the private monorepo. Grouped by subdirectory. app/services/email_service.py is explicitly excluded (OSS-only; private uses SendGrid via a different layout). - .github/workflows/parity-check.yml: triggers on PR, diffs against base, intersects touched files with the manifest, posts (or updates-in-place) a comment listing matches. Never blocks merge. Uses SHA-pinned actions per the repo's security rules. Gracefully skips when parity-manifest.json is missing. - README: new 'Open core model' section near the top linking to HOSTED_ONLY.md. - CHANGELOG [Unreleased] entry. No tests — this is docs + CI config. JSON and YAML validated locally. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
5 tasks
argus-qa-ai
approved these changes
Apr 17, 2026
Collaborator
argus-qa-ai
left a comment
There was a problem hiding this comment.
All CI checks passing. Approved by Argus.
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
Docs + CI only. Zero code changes, zero behavior changes.
HOSTED_ONLY.md— explains the open-core policy: what's intentionally hosted-only on cueapi.ai (billing, GDPR endpoints, blog pipeline, memory blocks, support-ticket routing, Jenny chatbot, deploy hook, dashboard UI, email alert delivery) and why.parity-manifest.json— enumerates the 60 files inapp/andalembic/that have a same-path counterpart in the private cueapi monorepo, grouped by subdirectory. One file (app/services/email_service.py) is explicitly listed as OSS-only..github/workflows/parity-check.yml— on each PR, intersects touched files with the manifest. If there are matches, posts (or updates-in-place) a comment asking the author to cross-reference the private repo. Never blocks merge — exits 0 unconditionally. Actions pinned to commit SHAs per the repo's security rules.HOSTED_ONLY.md.[Unreleased]entry.What the parity-check comment looks like
When someone touches, say,
app/services/outcome_service.py, the bot posts:The comment is idempotent: on subsequent pushes to the PR, it updates in place (via a hidden marker) rather than spamming the thread.
Decisions
worker/if that ever gets parity counterparts) just works.email_service.pyexcluded. It's OSS-only — private uses SendGrid via a different module layout. The manifest'soss_only_exclusionssection documents this so future maintainers don't add it by reflex.actions/github-scriptfor commenting rather than a third-party action, keeping the dependency surface minimal. SHA-pinned to v7.0.1.parity-manifest.json, the workflow emits a::notice::and exits — it doesn't fail the PR.Tests
None. This is docs + CI config.
python3 -c "import json; json.load(open('parity-manifest.json'))"→ OKpython3 -c "import yaml; yaml.safe_load(open('.github/workflows/parity-check.yml'))"→ OKThe workflow will self-exercise on this PR (which touches zero tracked files, so it should post no comment and log "No parity-tracked files modified").
Test plan
app/models/cue.pytriggers the comment🤖 Generated with Claude Code