From 0a649c4d5556db300fcb0ed75367269c7638519f Mon Sep 17 00:00:00 2001 From: Mihaela Mihaljevic Date: Sat, 6 Jun 2026 00:28:38 +0200 Subject: [PATCH] docs(release): prepare 0.1.1 --- CHANGELOG.md | 14 ++++++++++++ README.md | 2 +- docs/RELEASE.md | 22 +++++++++--------- docs/USAGE.md | 2 +- docs/releases/pureyaml-0-1-1.md | 40 +++++++++++++++++++++++++++++++++ 5 files changed, 67 insertions(+), 13 deletions(-) create mode 100644 docs/releases/pureyaml-0-1-1.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 3be8ec5..91b3915 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +No changes yet. + +## [0.1.1] - 2026-06-06 + +### Added + +- Add platform CI badges and an active production-hardening roadmap to the + README. + +### Changed + +- Add release-mode build and test gates to the macOS, Linux, Windows, and WASM + verification scripts. + ### Fixed - Treat more-indented plain scalar continuation lines that start with `-` as diff --git a/README.md b/README.md index 658b899..6249833 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ flowchart TB ## Status -The current release is 0.1.0. It includes block mappings, block sequences, +The current release is 0.1.1. It includes block mappings, block sequences, ordered mappings, common scalars, quoted strings, comments, flow collections, literal and folded block scalars, anchors, aliases, YAML directives, document markers, explicit built-in scalar tags, merge-key expansion, complex mapping keys, diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 3d33fbf..d2b40de 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -1,8 +1,8 @@ # Release Process -PureYAML versioning is driven by Git tags. The current release is 0.1.0. +PureYAML versioning is driven by Git tags. The current release is 0.1.1. -## 0.1.0 Release +## 0.1.1 Release - Swift tools version: 6.1 - Product: `PureYAML` @@ -10,7 +10,7 @@ PureYAML versioning is driven by Git tags. The current release is 0.1.0. - Source targets: Swift only, no C targets and no generated parser targets - Hosted CI matrix: macOS build and test, Linux build and test, Windows build and test, WASM build -- Release notes file: `docs/releases/pureyaml-0-1-0.md` +- Release notes file: `docs/releases/pureyaml-0-1-1.md` ## Local Verification @@ -63,19 +63,19 @@ Only run these commands after the local gates pass and hosted CI passes. ```sh git status --short --branch -git tag -a 0.1.0 -m "PureYAML 0.1.0" -git push origin main 0.1.0 -gh release create 0.1.0 \ +git tag -a 0.1.1 -m "PureYAML 0.1.1" +git push origin main 0.1.1 +gh release create 0.1.1 \ --repo mihaelamj/PureYAML \ - --title "PureYAML 0.1.0" \ - --notes-file docs/releases/pureyaml-0-1-0.md + --title "PureYAML 0.1.1" \ + --notes-file docs/releases/pureyaml-0-1-1.md ``` After publishing, verify the release exists: ```sh -git ls-remote --tags origin 0.1.0 -gh release view 0.1.0 --repo mihaelamj/PureYAML +git ls-remote --tags origin 0.1.1 +gh release view 0.1.1 --repo mihaelamj/PureYAML ``` ## Do Not Tag If @@ -84,6 +84,6 @@ gh release view 0.1.0 --repo mihaelamj/PureYAML - `Sources/` contains C, JavaScript, WebAssembly blobs, or generated parser runtime files. - Any Swift source imports Foundation in the library target. -- The changelog does not have a dated 0.1.0 section. +- The changelog does not have a dated 0.1.1 section. - The release notes omit known deferred issues. - macOS, Linux, Windows, or WASM CI is red or still running. diff --git a/docs/USAGE.md b/docs/USAGE.md index 8f2c739..d8c3436 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -8,7 +8,7 @@ and typed-converting the YAML subset currently covered by the test corpus. Depend on the tagged package version: ```swift -.package(url: "https://github.com/mihaelamj/PureYAML.git", .upToNextMinor(from: "0.1.0")) +.package(url: "https://github.com/mihaelamj/PureYAML.git", .upToNextMinor(from: "0.1.1")) ``` For unreleased development snapshots, use the `main` branch: diff --git a/docs/releases/pureyaml-0-1-1.md b/docs/releases/pureyaml-0-1-1.md new file mode 100644 index 0000000..e256a5c --- /dev/null +++ b/docs/releases/pureyaml-0-1-1.md @@ -0,0 +1,40 @@ +# PureYAML 0.1.1 + +PureYAML 0.1.1 is a patch release that ships parser compatibility fixes and +stronger release verification gates. + +## Highlights + +- Treat more-indented plain scalar continuation lines that start with `-` as + text unless they appear at a known sequence-entry indentation. This fixes + OpenAPI-style `allOf` descriptions while preserving nested block sequences + such as `- - 123`. +- Parse explicit scalar keys whose `:` value starts a same-line mapping and + continues with indented mapping siblings, matching large OpenAPI schema keys. +- Add release-mode build and test gates to macOS, Linux, Windows, and WASM + verification scripts. +- Add README platform CI badges and the production hardening roadmap. + +## Current Production Readiness + +PureYAML has Yams parse-success parity on the checked production corpus, but +that is not a proof of perfect YAML correctness. The active production +hardening work is tracked in #54, with child issues for structured validation +reports, diagnostic false-positive triage, malformed YAML coverage, +OpenAPIDoctor integration, Yams differential testing, and parser throughput. + +## Verification + +The release process requires: + +- `bash scripts/check-all.sh` +- hosted macOS CI +- hosted Linux CI +- hosted Windows CI +- hosted WASM CI + +## Installation + +```swift +.package(url: "https://github.com/mihaelamj/PureYAML.git", .upToNextMinor(from: "0.1.1")) +```