chore: open source setup#3
Conversation
… README.md, and remove outdated content from LICENSE file
… configuration files
…naming conventions
… before publishing
There was a problem hiding this comment.
Pull request overview
This PR standardizes tool naming (dropping the unified_ prefix), updates docs/tests accordingly, and adds GitHub Actions automation for CI, releases, and PR-title semantics as part of open-source repo setup.
Changes:
- Remove
unified_tool name/pattern usage across config, tests, and README (e.g.,documents_*,hris_*,ats_*,crm_*). - Add GitHub Actions workflows for Node CI, release automation via release-please, and semantic PR title enforcement.
- Update licensing to Apache-2.0 and ensure publish builds via
prepublishOnly.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/utils/field-detection.ts | Updates wildcard matching example to new tool patterns. |
| src/core/tool-result-sanitizer.ts | Updates doc examples for vertical/resource extraction to reflect new tool names. |
| src/config.ts | Removes unified_* defaults in tool overrides/rules and switches to non-prefixed patterns. |
| specs/utils.spec.ts | Updates wildcard tests to use documents_* pattern. |
| specs/integration.spec.ts | Updates integration tests to use non-unified_ tool names. |
| release-please-config.json | Adds release-please configuration (currently minimal). |
| .release-please-manifest.json | Adds initial release-please manifest version state. |
| .github/workflows/semantic-pull-request.yml | Adds PR title semantic validation workflow. |
| .github/workflows/release-please.yml | Adds release automation workflow for main branch. |
| .github/workflows/node-ci.yml | Adds CI workflow for build/lint/typecheck/test on PRs. |
| package.json | Adds prepublishOnly build step and updates license to Apache-2.0. |
| README.md | Updates docs for new tool patterns and license, removes repository-moved notice. |
| LICENSE | Replaces SSPL-1.0 with Apache License 2.0 text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| toolOverrides: { | ||
| // Document tools - focus on content fields | ||
| 'unified_documents_*': ['name', 'description', 'content', 'title'], | ||
| 'documents_*': ['name', 'description', 'content', 'title'], | ||
|
|
||
| // HRIS tools - employee data | ||
| 'unified_hris_*': ['name', 'notes', 'bio', 'description'], | ||
| 'hris_*': ['name', 'notes', 'bio', 'description'], | ||
|
|
||
| // ATS tools - candidate data | ||
| 'unified_ats_*': ['name', 'notes', 'description', 'summary'], | ||
| 'ats_*': ['name', 'notes', 'description', 'summary'], | ||
|
|
||
| // CRM tools - customer data | ||
| 'unified_crm_*': ['name', 'description', 'notes', 'content'], | ||
| 'crm_*': ['name', 'description', 'notes', 'content'], | ||
|
|
There was a problem hiding this comment.
Default config no longer matches unified_* tool names (toolOverrides and toolRules). If any consumers still send tool names like unified_documents_*, they will now fall back to generic risky-field detection / default risk levels, which changes sanitization behavior. Consider supporting both patterns during a deprecation window (e.g., keep unified_documents_* alongside documents_* / regex ^unified_documents_|^documents_), or explicitly treat this as a breaking change and remove the remaining unified special-casing elsewhere.
| ".": {} | ||
| } |
There was a problem hiding this comment.
release-please-config.json only defines packages without specifying a release-type (and optionally package-name). In manifest mode, release-please typically needs an explicit release type (e.g. node) to know how to compute versions/changelogs; otherwise the workflow may fail or behave unexpectedly. Recommend adding the appropriate per-package configuration for this repo/package.
| ".": {} | |
| } | |
| ".": { | |
| "release-type": "node" | |
| } |
| deps | ||
| deps-dev | ||
| workflow | ||
| requireScope: true |
There was a problem hiding this comment.
With requireScope: true and the configured scopes list, this PR title ("Chore/open source setup") will fail the new PR-title check as written. Either update the PR title to match the enforced convention, or relax the workflow rules (e.g., make scope optional / broaden allowed scopes) to avoid blocking merges unexpectedly.
| requireScope: true | |
| requireScope: false |
| permissions: | ||
| id-token: write | ||
| contents: read | ||
|
|
There was a problem hiding this comment.
Workflow permissions include id-token: write, but this job doesn't appear to use OIDC/token minting. Consider removing unused permissions (and documenting the required REPO_GH_PAT secret) to keep the workflow least-privilege and reduce maintenance surprises if the secret isn't set in the repo.
This pull request introduces several improvements and standardizations to the repository's configuration, documentation, and codebase. The most significant changes are the removal of the
unified_prefix from tool patterns and names throughout the code, tests, and documentation, as well as the addition of GitHub Actions workflows for CI, release management, and semantic PR title checks. The license has also been updated from SSPL-1.0 to Apache-2.0.Tool naming and pattern standardization:
unified_prefix from tool patterns and names in code (src/config.ts,src/core/tool-result-sanitizer.ts,src/utils/field-detection.ts), tests (specs/integration.spec.ts,specs/utils.spec.ts), and documentation (README.md). Tool patterns are now simplydocuments_*,hris_*,ats_*, andcrm_*instead of theirunified_variants. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16]Repository automation and release management:
.github/workflows/node-ci.yml), release automation with release-please (.github/workflows/release-please.yml,release-please-config.json,.release-please-manifest.json), and semantic PR title validation (.github/workflows/semantic-pull-request.yml). [1] [2] [3] [4] [5]Documentation updates:
README.mdto remove the repository move notice, reflect the new tool patterns, and change the license reference to Apache-2.0. [1] [2] [3] [4] [5]License change:
package.jsonandREADME.md. [1] [2]Build and publish process improvements:
prepublishOnlyscript to ensure the project is built before publishing, and updated thepublish-releasescript inpackage.json.These changes collectively modernize the repository, improve consistency, and streamline release and CI/CD processes.