Skip to content

Add TPEN-side sender workflow for shared OpenAPI artifact sync to cubap/rerum_openapi#522

Open
Copilot wants to merge 4 commits into
mainfrom
copilot/add-sender-sync-workflow
Open

Add TPEN-side sender workflow for shared OpenAPI artifact sync to cubap/rerum_openapi#522
Copilot wants to merge 4 commits into
mainfrom
copilot/add-sender-sync-workflow

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 9, 2026

This PR adds TPEN-services as the canonical editing surface for the shared OpenAPI artifact and automates export into cubap/rerum_openapi via 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)

    • Added openapi/components/tpen-services-shared-components.openapi.yaml as the source-of-truth shared contract artifact in a discoverable OpenAPI components layout.
    • Normalized artifact baseline metadata/structure for seam rollout consistency (OpenAPI version, contract version, provider metadata, and components.schemas stub).
  • Sender sync workflow (cross-repo PR automation)

    • Added .github/workflows/sync_tpen_shared_openapi.yaml.
    • Triggers on:
      • pushes to development that touch the shared artifact
      • manual workflow_dispatch
    • Behavior:
      • checks out cubap/rerum_openapi
      • copies TPEN provider artifact to schemas/openapi/tpen-services-shared-components.openapi.yaml
      • opens or updates an automation sync PR branch in the receiver repo
      • uses standardized seam-rollout PR branch/message conventions and OPENAPI secret token
  • Repo-level guardrails for sync scaffolding

    • Extended existing existence checks to assert both:
      • openapi/components/tpen-services-shared-components.openapi.yaml
      • .github/workflows/sync_tpen_shared_openapi.yaml
    • Added focused test coverage in __tests__/openapi_sync_artifacts.test.js to validate:
      • provider artifact baseline structure
      • workflow sync configuration
# .github/workflows/sync_tpen_shared_openapi.yaml
- name: Copy shared OpenAPI artifact into receiver repository
  run: |
    cp openapi/components/tpen-services-shared-components.openapi.yaml \
      rerum_openapi/schemas/openapi/tpen-services-shared-components.openapi.yaml

Copilot AI linked an issue May 9, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add sender sync workflow for shared OpenAPI artifacts Add TPEN-side sender workflow for shared OpenAPI artifact sync to cubap/rerum_openapi May 9, 2026
Copilot finished work on behalf of cubap May 9, 2026 01:59
Copilot AI requested a review from cubap May 9, 2026 01:59
@cubap
Copy link
Copy Markdown
Member

cubap commented May 15, 2026

@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

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 15, 2026

@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

Updated in commit 3eb83b3 to align with current seam rollout conventions: standardized sync workflow conventions (token, branch naming, PR metadata), normalized shared artifact baseline fields, and added focused scaffolding tests for the sync artifact/workflow contract.

Copilot finished work on behalf of cubap May 15, 2026 21:21
@cubap cubap marked this pull request as ready for review May 15, 2026 21:22
@cubap cubap requested a review from thehabes as a code owner May 15, 2026 21:22
@cubap cubap requested a review from Copilot May 15, 2026 21:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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_openapi and 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.

Comment thread __tests__/openapi_sync_artifacts.test.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add sender sync workflow for shared OpenAPI artifacts

3 participants