Skip to content

CorieW/template-subscriber-migration-system

Repository files navigation

Template Subscriber Migration System

image
GitHub Actions helpers for publishing template changes as migration bundles and letting subscriber repositories opt into subscriber-specific migration PRs.

Use this when one repository acts as an upstream template and many downstream repositories need a controlled way to receive template changes after they have drifted.

Documentation

The docs are the source of truth for setup and configuration:

Internal development, release, and docs deployment notes live in DEV.md.

What Ships

This package provides three binaries:

Command Purpose
publish-template-migration Publish a GitHub Release migration bundle for a merged template PR.
subscriber-template-sync Discover the newest template migration and open a draft subscriber PR.
handle-template-sync-command Handle /template-sync approve, /template-sync revise, and /template-sync decline.

It also includes example GitHub Actions workflows for template publishing, subscriber discovery, and migration commands.

Install

Workflows default to the latest published package. Change the suffix to pin or test another version:

env:
  TEMPLATE_SYNC_PACKAGE: template-subscriber-migration-system@latest

Install a workflow binary without package lifecycle scripts, then run it:

prefix="$(mktemp -d)"
npm install --global --prefix "$prefix" --ignore-scripts template-subscriber-migration-system@latest
PATH="$prefix/bin:$PATH"
subscriber-template-sync

Or install locally:

npm install --save-dev template-subscriber-migration-system

Development

Requires Node.js 20 or newer.

npm test
npm run lint
npm run docs:dev
npm run pack:check

About

GitHub-native template migrations, delivered as reviewed subscriber PRs.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors