Skip to content

Update package metadata and add core-validation package with dependencies - #8

Open
kcargile wants to merge 1 commit into
developfrom
k/cr009-cr014
Open

kcargile wants to merge 1 commit into
developfrom
k/cr009-cr014

Conversation

@kcargile

Copy link
Copy Markdown
Contributor

This pull request finalizes the core agent guidance documentation for the OEI Core repository, aligning it with current project conventions and establishing a foundation for future publish readiness. The main updates include a complete rewrite of AGENTS.md, the introduction of a synthesized Copilot instructions file, and the creation of a detailed publish readiness registry. Documentation navigation and registry references have also been updated to reflect these additions.

Core Documentation and Guidance Updates:

  • Rewrote AGENTS.md to provide comprehensive, core-specific guidance on repository scope, package layout, documentation, tooling, branching, release process, and OSS posture. This replaces the previous placeholder and brings the guidance in line with OEI standards.
  • Added .github/copilot-instructions.md, synthesizing agent guidance from AGENTS.md for use by Copilot and other AI agents. This ensures consistent instructions for automated tooling and contributors.

Publish Readiness and Registry Improvements:

  • Created docs/registry/core-publish-readiness-registry.md, a detailed tracker for all workstreams required to bring OEI Core to publish-ready status, including audit status, evidence, and next steps for each item.
  • Updated documentation navigation: added the core publish readiness registry to docs/TOC.md and referenced it in docs/registry/README.md for improved discoverability. [1] [2]

Release Process and Changelog:

  • Added a changeset entry to document these updates and trigger a patch release for @openendurance/core.

…cies

Signed-off-by: Kristopher Cargile <k@algorythmic.com>
@kcargile kcargile added this to the Initial Release milestone Oct 20, 2026
@kcargile kcargile self-assigned this Oct 20, 2026
Copilot AI balanced review requested due to automatic review settings October 20, 2026 14:48
@kcargile kcargile added the enhancement New feature or request label Oct 20, 2026
@github-project-automation github-project-automation Bot moved this to Todo in OEI Core Oct 20, 2026
@changeset-bot

changeset-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 49417eb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Publishing safeguards still allow stale core artifacts and an unusable validation placeholder to be released.

2 open issues
1 file not reviewed
  • pnpm-lock.yaml: Generated file
What changed in this PR

This PR prepares OEI’s shared packages for publishing by updating metadata and introducing the validation workspace manifest.

Changes:

  • Enables public publishing, provenance, and a prepack build for core.
  • Moves runtime dependencies into packages and adds validation dependencies.
  • Updates readiness tracking and editor dictionary entries.
File Description
pnpm-lock.yaml Synchronizes workspace dependencies.
packages/​core/​package.json Updates publishing metadata and build hooks.
packages/​core-validation/​package.json Defines the validation package and dependencies.
package.json Updates licensing and removes root runtime dependencies.
docs/​registry/​core-publish-readiness-registry.md Updates package-readiness status.
.vscode/​settings.json Adds package keywords to the spelling dictionary.

Review effort: Balanced

Comment thread packages/core-validation/package.json
Comment on lines 51 to +55
"build": "tsc --build tsconfig.build.json && tsc-alias",
"build:ci": "pnpm build",
"clean": "rm -rf .turbo coverage dist node_modules *.tsbuildinfo",
"lint": "pnpm exec biome lint",
"prepack": "pnpm run build",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants