From 31be9deb6a5f9f13cc16e94ee03bb7e69f2c7770 Mon Sep 17 00:00:00 2001 From: DanMat Date: Sun, 2 Aug 2026 11:41:19 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20alpha=20release=20prep=20=E2=80=94=20CH?= =?UTF-8?q?ANGELOG=20and=20composer=20validation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Prepares nimbuscms/markdown 0.1.0-alpha.1, coordinated with core's alpha (the tag itself is left to a human). - CHANGELOG.md documenting the field type, the runtime dependency on core, the dev-main pre-release pin and its move to ^0.1 once core is published, and the deliberate non-features (no HTML rendering, no JS, no routes/migrations). - CI validates composer.json with --strict. - README links the changelog and the core compatibility policy. Co-Authored-By: Claude Opus 4.8 --- .github/workflows/ci.yml | 3 +++ CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 3 files changed, 44 insertions(+) create mode 100644 CHANGELOG.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8db228f..a3f0641 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,6 +22,9 @@ jobs: extensions: mbstring coverage: none + - name: Validate composer.json + run: composer validate --strict + - name: Install dependencies run: composer install --no-interaction --prefer-dist --no-progress diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6005bf8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,37 @@ +# Changelog + +Notable changes to the official NimbusCMS Markdown plugin. Follows +[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and +[Semantic Versioning](https://semver.org). + +## [Unreleased] + +## [0.1.0-alpha.1] — 2026-08-02 + +The first tagged release, coordinated with `nimbuscms/nimbus` 0.1.0-alpha.1. + +### Added + +- A `markdown` field type: an admin textarea that stores Markdown **source**, + normalizes line endings only, enforces an optional maximum length, escapes + stored markup, and returns source from `toApi()`. +- Registers through the public `PluginContext`, requiring no changes to Nimbus + core. +- Degrades safely when disabled — the stored source is preserved, shown + read-only, and saves are blocked until the plugin is re-enabled. + +### Compatibility + +- Requires `nimbuscms/nimbus` at runtime. During the pre-release period this is + pinned to `dev-main`; it moves to `^0.1` once core is published to Packagist + (tracked under Release & packaging in the core roadmap). +- Tested against PHP 8.2 and 8.3. + +### Not included (by design) + +Renders no HTML, ships no JavaScript editor, and adds no routes, migrations, +admin navigation or permissions. Those wait for capabilities core does not yet +expose. This plugin exists to exercise field-type registration and nothing more. + +[Unreleased]: https://github.com/NimbusCMS/plugin-markdown/compare/v0.1.0-alpha.1...HEAD +[0.1.0-alpha.1]: https://github.com/NimbusCMS/plugin-markdown/releases/tag/v0.1.0-alpha.1 diff --git a/README.md b/README.md index 4cdcaf1..0ce71bd 100644 --- a/README.md +++ b/README.md @@ -115,3 +115,7 @@ replacing it. ## License [MIT](LICENSE) + +## Changelog + +See [CHANGELOG.md](CHANGELOG.md). Compatibility with core is documented in the core [COMPATIBILITY](https://github.com/NimbusCMS/nimbus/blob/main/docs/COMPATIBILITY.md) policy.