Skip to content

Commit f5ccc42

Browse files
authored
Prepare Swift-JSON 1.0.0 release documentation (#6)
1 parent 993db41 commit f5ccc42

5 files changed

Lines changed: 29 additions & 19 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Changelog
22

3-
## Unreleased
3+
## 1.0.0 — 2026-10-11
4+
5+
First stable release.
46

57
- Public GitHub Pages documentation with four native DocC references; the exact
68
artifact publishes from `main` after native, safety and documentation CI pass.
@@ -30,9 +32,9 @@
3032
Qualification details and counts are in Documentation/Qualification/README.md. Resource
3133
policy bounds logical work/ownership; it is not an operating-system RSS ceiling.
3234
E09 keeps scalar scanning and no retained scratch pool. SIMD and regex prefilters
33-
remain unselected; projection and RFC 7464 framing remain deferred. No version tag or release has been created.
35+
remain unselected; projection and RFC 7464 framing remain deferred.
3436

35-
### Candidate verification refinements
37+
### Exact coding and public reports
3638

3739
- Reject lossy native String-dictionary and changed CodingKey spelling projections.
3840
- Add exact JSONObject Codable round-trips and a raw-schema compile report that

‎README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ partially read document would change the meaning of your data.
1313

1414
[Read the documentation →](https://thorfuchs.github.io/Swift-JSON/)
1515

16-
Maintained by [Thorsten Fuchs](https://github.com/ThorFuchs). The repository is public;
17-
**version 1.0.0 has not yet been tagged or released**. Until a version is published,
18-
use `main` and retain the resolved commit for reproducible builds.
16+
Maintained by [Thorsten Fuchs](https://github.com/ThorFuchs). Swift-JSON follows
17+
semantic versioning. Use a released version and retain `Package.resolved` for
18+
reproducible builds; `main` tracks ongoing development.
1919

2020
## Why Swift-JSON?
2121

@@ -75,7 +75,7 @@ packages.
7575
Add the package to your `Package.swift`:
7676

7777
```swift
78-
.package(url: "https://github.com/ThorFuchs/Swift-JSON.git", branch: "main")
78+
.package(url: "https://github.com/ThorFuchs/Swift-JSON.git", from: "1.0.0")
7979
```
8080

8181
Then add products to your target dependencies:
@@ -86,9 +86,10 @@ Then add products to your target dependencies:
8686
```
8787

8888
Add `JSONStreaming` and `JSONPatch` in the same way when needed. A local checkout can
89-
use `.package(path: "../Swift-JSON")`. After a release is published, select a semantic
90-
version requirement. See the [four-product consumer](Examples/Consumer) for a
91-
complete buildable manifest.
89+
use `.package(path: "../Swift-JSON")`. The requirement above accepts compatible 1.x
90+
releases. See the [four-product consumer](Examples/Consumer) for a complete buildable
91+
manifest. The website tracks `main`; release assets include compiled DocC catalogues
92+
for the exact released source.
9293

9394
## Parse, inspect and write exact values
9495

‎RELEASING.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Release process
22

3-
No version tag or GitHub release exists yet. Maintainer: @ThorFuchs. Publication
4-
requires a separate explicit instruction; CI never creates tags or releases.
3+
Maintainer: @ThorFuchs. Version tags use semantic versions such as `1.0.0`.
4+
Publication requires an explicit maintainer instruction; CI never creates tags
5+
or releases. Published version tags are protected against updates and deletion.
56

67
1. Require passed native, safety and documentation lanes for the exact candidate
78
commit on macOS/SDK 27+ and Swift 6.4+ with language mode 6.
@@ -20,6 +21,14 @@ requires a separate explicit instruction; CI never creates tags or releases.
2021
`Scripts/ci.py --lane native`.
2122
6. Retain source identity, environment, command exits, nonzero counts and receipts.
2223
Verify private reporting, support routes and branch protections.
24+
7. Create an annotated version tag at the exact qualified commit. Check its target
25+
before pushing: published tags cannot be moved. Prepare release notes, the source
26+
archive, the matching compiled DocC archive, a public qualification receipt and
27+
SHA-256 checksums. Upload only reviewed public assets; private maintainer records
28+
remain outside Git and the public release.
29+
8. Verify the release assets against the checksum file and confirm that a separate
30+
SwiftPM consumer resolves the version tag. A draft release is preparation;
31+
publish it only when publication has been explicitly requested.
2332

24-
Tagging 1.0.0 and creating its release are deliberate maintainer actions after
33+
Creating a version tag and its GitHub release are deliberate maintainer actions after
2534
this review. A successful CI run alone does not authorize them.

‎SECURITY.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,10 @@ no response-time or remediation SLA is promised.
1818

1919
## Supported versions
2020

21-
Once the first stable release exists, security and defect fixes target the latest
21+
Security and defect fixes target the latest
2222
published **1.x** release. Older patch/minor versions should upgrade to that release.
2323
No backport or extended-support commitment is made for older release lines.
24-
Before 1.0.0 is released, the current `main` candidate receives best-effort fixes;
25-
there is no published stable version yet. See [SUPPORT.md](SUPPORT.md).
24+
See [SUPPORT.md](SUPPORT.md) for the maintenance policy.
2625

2726
## Boundaries
2827

‎SUPPORT.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ defects, documentation corrections and focused feature proposals. For security
66
reports, use the private route in [SECURITY.md](SECURITY.md).
77

88
The stable support policy is **the latest published 1.x release**. Fixes are shipped
9-
in that line; users of older 1.x versions should upgrade. Before the first stable
10-
release, `main` is a candidate with best-effort maintenance. There is currently no
11-
1.0.0 tag or GitHub release. No paid support, response-time SLA or older-line
9+
in that line; users of older 1.x versions should upgrade. The `main` branch tracks
10+
development and receives best-effort maintenance. No paid support, response-time SLA or older-line
1211
backport commitment is implied.
1312

1413
The package requires Swift tools/compiler 6.4+, Swift language mode 6 and

0 commit comments

Comments
 (0)