This repository is the parent maintenance workspace for keeping AWCMS-Micro aligned with the latest EmDash source.
Analyze https://github.com/emdash-cms/emdash, then update https://github.com/ahliweb/awcms-micro so it stays fully synchronized with EmDash.
awcms-micro is an independent repository. It must not act as a host for other repositories in the product or runtime sense. It should serve as an example implementation that adopts EmDash 100% and includes only example plugins and example templates that follow the AWCMS-Micro standard, without modifying EmDash core.
AWCMS-Micro-specific product development in this maintenance workspace is limited to plugin and template boundaries. Root scripts and root documentation may change to support that workflow, but new product behavior should not be introduced through EmDash core forks or new shared core layers.
This workspace uses three separate versioning and changelog surfaces:
- root maintenance changes for the parent repository live in
VERSION,CHANGELOG.md, and root.awcms-changesets/ - plugin packages under
awcmsmicro-dev/packages/plugins/keep their ownpackage.jsonversion andCHANGELOG.md - template packages under
awcmsmicro-dev/templates/keep their ownpackage.jsonversion andCHANGELOG.md
CHANGELOG.md also carries a workspace snapshot of the current EmDash upstream SHA plus the version and latest changelog entry for every plugin and template in awcmsmicro-dev/.
Keep these flows separate so root maintenance releases do not mix with package releases, while the snapshot stays current.
- The root maintenance workspace is MIT licensed. See
LICENSE. - AWCMS-Micro example plugins and templates use the AW Non-Commercial License 1.0 from
https://github.com/ahliweb/aw-non-commercial-license. docs/awcms-micro-licensing.mdexplains how the root MIT license and package-level non-commercial license fit together.
emdash-latest/: latest synchronized snapshot of upstream EmDashawcmsmicro-dev/: clone ofemdash-latest/used as the active AWCMS-Micro development workspacedocs/: root-level technical documentation for structure, sync workflow, and implementation rulesscripts/: maintenance scripts for refreshingemdash-latest/and rebuildingawcmsmicro-dev/
Hidden root files such as .gitignore and local-only .env support the parent workspace and are not part of the product structure.
- Keep
emdash-latest/as the clean upstream reference tree. - Rebuild
awcmsmicro-dev/fromemdash-latest/before AWCMS-Micro-specific implementation work. - Do not treat this repository as a runtime host for nested products.
- Keep root documentation synchronized with the actual workflow and folder layout.
- Work step by step using small, atomic changes.
- When a task is too large, split it into smaller follow-up tasks or GitHub issues.
English (US) is the official repository language for root documentation, root scripts, repository instructions, and AWCMS-Micro-specific repository governance text.
Exception:
emdash-latest/must remain as an upstream-faithful EmDash snapshot and should preserve upstream wording as-is, including non-US spelling when present.awcmsmicro-dev/may mirror upstream wording when it is rebuilt fromemdash-latest/as part of synchronization work.
docs/README.mddocs/repository-structure.mddocs/synchronization-workflow.mddocs/implementation-instructions.mddocs/awcms-micro-implementation-boundaries.mddocs/repository-assessment.mddocs/decision-records.mddocs/operator-workflow.mddocs/awcms-micro-prd.mddocs/awcms-micro-versioning.mddocs/awcms-micro-root-versioning.mddocs/awcms-micro-versioning-rollout-summary.mddocs/awcms-micro-licensing.mddocs/awcms-micro-d1-mirror-sync.mddocs/upstream-sync/README.mddocs/upstream-sync/ISSUE_CLASSIFICATION_DOWNSTREAM_VS_UPSTREAM.mddocs/upstream-sync/UPSTREAM_PR_PLAN_ADMIN_SIDEBAR_ORDERING.mddocs/deployment/cloudflare.mddocs/security/security-baseline.md
bash scripts/update-emdash-latest.shbash scripts/update-awcmsmicro-dev.shbash scripts/validate-awcmsmicro-boundaries.shbash scripts/validate-awcmsmicro-dev.shbash scripts/sync-and-validate-awcmsmicro-dev.shnode awcmsmicro-dev/.github/scripts/awcms-version.mjs statusnode awcmsmicro-dev/.github/scripts/awcms-version.mjs versionbash scripts/awcms-root-versioning.sh statusbash scripts/awcms-root-versioning.sh versionnode scripts/awcms-version.mjs statusnode scripts/awcms-version.mjs versionpnpm --dir awcmsmicro-dev d1:mirror:statuspnpm --dir awcmsmicro-dev d1:mirror:syncpnpm --dir awcmsmicro-dev d1:mirror:resetpnpm --dir awcmsmicro-dev d1:mirror:watchpnpm --dir awcmsmicro-dev test:e2e
bash scripts/backup/encrypt-config.sh- Encrypt backup configbash scripts/backup/decrypt-config.sh- Decrypt backup configbash scripts/backup/encrypt-all-env.sh- Encrypt all .env filesbash scripts/backup/encrypt-env.sh- Encrypt .env filesbash scripts/backup/decrypt-env.sh- Decrypt .env filesbash scripts/backup/backup-db.sh- Backup database to R2bash scripts/backup/backup-dotfiles.sh- Backup dotfilesbash scripts/backup/restore-dotfiles.sh- Restore dotfilesbash scripts/backup/recovery-checklist.sh- Disaster recovery guide
See scripts/backup/README.md for full documentation.
- CLA enforcement is not active in this workspace.
- Contributions are governed by repository review, issue tracking, and the standard approval flow used by maintainers.
- Example template:
awcmsmicro-dev/templates/awcms-micro-default/ - Example Cloudflare template:
awcmsmicro-dev/templates/awcms-micro-default-cloudflare/ - Example plugin:
awcmsmicro-dev/packages/plugins/awcms-micro-sikesra/ - Example gallery plugin:
awcmsmicro-dev/packages/plugins/awcms-micro-gallery/ - Reserved Cloudflare demo boundary:
awcmsmicro-dev/demos/awcms-micro-cloudflare/ - Reserved docs boundary:
awcmsmicro-dev/docs/awcms-micro/ - Reserved gallery docs boundary:
awcmsmicro-dev/docs/gallery/ - Reserved E2E boundary:
awcmsmicro-dev/e2e/awcms-micro/ - Reserved AWCMS changesets boundary:
awcmsmicro-dev/.awcms-changesets/ - Preserved workflow boundary:
awcmsmicro-dev/.github/workflows/ - Preserved workflow scripts boundary:
awcmsmicro-dev/.github/scripts/ - Preserved Dependabot config:
awcmsmicro-dev/.github/dependabot.yml - Approved implementation boundaries:
docs/awcms-micro-implementation-boundaries.md - Protected implementation boundary list:
scripts/awcmsmicro-dev-protected-paths.txt - Upstream sync tracking:
docs/upstream-sync/ - Deployment guidance:
docs/deployment/ - Security and compliance baselines:
docs/security/
- Refresh
emdash-latest/from upstream EmDash. - Rebuild
awcmsmicro-dev/fromemdash-latest/. - Validate
awcmsmicro-dev/withbash scripts/validate-awcmsmicro-dev.sh. - Implement AWCMS-Micro-specific product work only in approved plugin and template boundaries inside
awcmsmicro-dev/. - Prepare
.awcms-changesets/entries when AWCMS plugins or templates need downstream version bumps. - Update root documentation when structure or process changes.
During rebuilds, bash scripts/update-awcmsmicro-dev.sh preserves only the explicitly approved AWCMS-Micro paths listed in scripts/awcmsmicro-dev-protected-paths.txt and governed by docs/awcms-micro-implementation-boundaries.md.