Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 8 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,15 @@ jobs:
path: reference-html

- name: Package release documentation
run: tar -C reference-html -czf pjson-api-reference.tar.gz .
run: |
tar -C reference-html -czf pjson-api-reference.tar.gz .
sha256sum pjson-api-reference.tar.gz > pjson-api-reference.tar.gz.sha256

- name: Attach documentation archive
- name: Attach documentation archive and checksum
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ github.event.release.tag_name }}
run: >-
gh release upload "${RELEASE_TAG}"
pjson-api-reference.tar.gz
run: |
gh release upload "${RELEASE_TAG}" \
pjson-api-reference.tar.gz \
pjson-api-reference.tar.gz.sha256
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and releases follow

## [Unreleased]

## [1.0.0] - 2026-08-31

### Added

- Introduced the versioned C++11 API for pjson 1.0, including compile-time
Expand Down Expand Up @@ -117,7 +119,8 @@ on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and releases follow

- Initial pjson source release.

[Unreleased]: https://github.com/Pico-Developer/pjson/compare/release-0.0.3...HEAD
[Unreleased]: https://github.com/Pico-Developer/pjson/compare/1.0.0...HEAD
[1.0.0]: https://github.com/Pico-Developer/pjson/compare/release-0.0.3...1.0.0
[0.0.3]: https://github.com/Pico-Developer/pjson/compare/release-0.0.2...release-0.0.3
[0.0.2]: https://github.com/Pico-Developer/pjson/compare/release-0.0.1...release-0.0.2
[0.0.1]: https://github.com/Pico-Developer/pjson/releases/tag/release-0.0.1
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
`obj["key"][i] = value` style API.
- Licensed under Apache-2.0;
- Current source version: **1.0.0** (`pjson::getVersion()` / the
`PJSON_VERSION` macro). This version remains unreleased until the
`release-1.0.0` tag is published.
`PJSON_VERSION` macro).

---

Expand Down
6 changes: 3 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Release Process

This checklist is for project maintainers. Releases use Semantic Versioning and
the `release-MAJOR.MINOR.PATCH` tag convention described in
the `MAJOR.MINOR.PATCH` tag convention described in
[`VERSIONING.md`](VERSIONING.md).

## 1. Prepare the release
Expand Down Expand Up @@ -146,8 +146,8 @@ out, create an annotated tag. Sign it when the maintainer has a configured,
project-recognized signing key.

```sh
git tag -a release-X.Y.Z -m "pjson X.Y.Z"
git push origin release-X.Y.Z
git tag -a X.Y.Z -m "pjson X.Y.Z"
git push origin X.Y.Z
```

Create a GitHub release from that exact tag. Use `pjson X.Y.Z` as the title and
Expand Down
8 changes: 3 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@

## Supported versions

Once 1.0.0 is published, pjson intends to provide security fixes for the current
stable release line. The `1.0.0` source is currently under development, so there
is no supported stable line until `release-1.0.0` is published. Reports against
`main` are welcome and fixes are released as soon as practical.
pjson provides security fixes for the current stable release line. Reports
against `main` are also welcome and fixes are released as soon as practical.

| Version | Supported |
| --- | --- |
| `main` / 1.0.0 development | Pre-release reports accepted |
| 1.0.x | Yes |
| 0.0.x | No |

Users of an unsupported version should upgrade before reporting a problem that
Expand Down
15 changes: 7 additions & 8 deletions VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
# Versioning Policy

pjson uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html). The
current source/development version is **1.0.0**, which remains unreleased until
the `release-1.0.0` tag is published. The latest published tag is `release-0.0.3`;
historical `0.0.x` releases predate this stability policy.
current stable version is **1.0.0**. Historical `0.0.x` releases used a
`release-` tag prefix and predate this stability policy.

## Version meaning

Expand Down Expand Up @@ -60,11 +59,11 @@ is a release-blocking defect.

## Tags and pre-releases

Release tags follow the repository's established
`release-MAJOR.MINOR.PATCH` form, for example `release-1.0.0`. Pre-release
identifiers use Semantic Versioning syntax, for example
`release-1.1.0-rc.1`. Published tags are immutable; a correction is released
under a new version rather than moving an existing tag.
Release tags use the plain Semantic Versioning `MAJOR.MINOR.PATCH` form, for
example `1.0.0`. Pre-release identifiers use Semantic Versioning syntax, for
example `1.1.0-rc.1`. Historical `0.0.x` tags retain their original `release-`
prefix. Published tags are immutable; a correction is released under a new
version rather than moving an existing tag.

Development happens on `main`. Until a release tag is published, its changes
remain under the `Unreleased` heading in `CHANGELOG.md`.
Loading