Add TPEN-side sender workflow for shared OpenAPI artifact sync to cubap/rerum_openapi#522
Add TPEN-side sender workflow for shared OpenAPI artifact sync to cubap/rerum_openapi#522Copilot wants to merge 4 commits into
cubap/rerum_openapi#522Conversation
Agent-Logs-Url: https://github.com/CenterForDigitalHumanities/TPEN-services/sessions/7492f37f-92a2-4dfe-8273-a5988b4741fc Co-authored-by: cubap <1119165+cubap@users.noreply.github.com>
Agent-Logs-Url: https://github.com/CenterForDigitalHumanities/TPEN-services/sessions/7492f37f-92a2-4dfe-8273-a5988b4741fc Co-authored-by: cubap <1119165+cubap@users.noreply.github.com>
cubap/rerum_openapi
|
@copilot Look at https://github.com/CenterForDigitalHumanities/.github-private/blob/main/.copilot/prompts/openapi-seam-rollout.prompt.md and make sure this PR is up to date with the current practice |
Agent-Logs-Url: https://github.com/CenterForDigitalHumanities/TPEN-services/sessions/ca5b71a2-fa7f-471c-aeef-887c2885556b Co-authored-by: cubap <1119165+cubap@users.noreply.github.com>
Updated in commit |
There was a problem hiding this comment.
Pull request overview
This PR introduces TPEN-services as the canonical source for a shared OpenAPI components artifact and adds automation to sync that artifact into cubap/rerum_openapi via an auto-updating pull request workflow.
Changes:
- Added a new shared OpenAPI components provider artifact under
openapi/components/. - Added a GitHub Actions workflow to copy the artifact into
cubap/rerum_openapiand create/update an automation PR. - Extended database-independent existence/scaffolding tests to assert the new artifact and workflow exist, and added a focused test for baseline content.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| openapi/components/tpen-services-shared-components.openapi.yaml | Introduces the canonical shared OpenAPI components artifact with baseline metadata and an empty components.schemas. |
| .github/workflows/sync_tpen_shared_openapi.yaml | Adds cross-repo PR automation to sync the shared artifact into cubap/rerum_openapi. |
| tests/openapi_sync_artifacts.test.js | Adds exists-suite coverage to validate provider artifact baseline fields and workflow sync scaffolding. |
| tests/mount.test.js | Extends existence checks to assert the new OpenAPI artifact and sync workflow files are present. |
This PR adds TPEN-services as the canonical editing surface for the shared OpenAPI artifact and automates export into
cubap/rerum_openapivia PR updates. It establishes a standard provider path in this repo while keeping consumers anchored to the receiver repo artifact, and aligns the sync implementation with current OpenAPI seam rollout conventions.Canonical provider artifact (TPEN-owned)
openapi/components/tpen-services-shared-components.openapi.yamlas the source-of-truth shared contract artifact in a discoverable OpenAPI components layout.components.schemasstub).Sender sync workflow (cross-repo PR automation)
.github/workflows/sync_tpen_shared_openapi.yaml.developmentthat touch the shared artifactworkflow_dispatchcubap/rerum_openapischemas/openapi/tpen-services-shared-components.openapi.yamlOPENAPIsecret tokenRepo-level guardrails for sync scaffolding
openapi/components/tpen-services-shared-components.openapi.yaml.github/workflows/sync_tpen_shared_openapi.yaml__tests__/openapi_sync_artifacts.test.jsto validate: