Skip to content

docs: alpha release prep — CHANGELOG and composer validation #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanMat merged 1 commit into from
Aug 2, 2026
Merged

docs: alpha release prep — CHANGELOG and composer validation #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
37 changes: 37 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading