Skip to content
This repository was archived by the owner on Oct 10, 2026. It is now read-only.

Commit 9ed51c0

Browse files
committed
Prepare for v0.1 release
1 parent 5e0ae05 commit 9ed51c0

15 files changed

Lines changed: 54 additions & 613 deletions

‎.github/workflows/ci.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
build-and-test:
9+
runs-on: ${{ matrix.os }}
10+
strategy:
11+
fail-fast: false
12+
matrix:
13+
os: [ubuntu-latest, macos-latest]
14+
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
19+
- name: Build
20+
run: make clean && make all
21+
22+
- name: Test
23+
run: make test

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
## [0.1.0] - 2026-05-18
6+
7+
Initial public release of `psa-parser`.
8+
9+
- Provides a C parser library for PSA planogram files with streaming callbacks.
10+
- Includes JSON helper APIs and document-oriented parse helpers.
11+
- Ships a CLI supporting document output, NDJSON streaming, and summary mode.
12+
- Includes test coverage for numeric parsing, preprocessing, JSON encoding, and sample parsing.
13+
- Adds integration guidance for foreign-language bindings via `docs/bindings.md`.

‎README.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ No external runtime dependencies are required for the parser library or CLI.
2222
- `src/`: parser, record mapping, JSON helpers
2323
- `cli/main.c`: command-line interface
2424
- `tests/`: unit and synthetic integration tests
25-
- `spec/`: file format and record mapping specification
25+
- `docs/spec/`: file format and record mapping specification
2626

2727
## Development Commands
2828

@@ -95,3 +95,10 @@ Help:
9595
- `psa_parse_buffer_to_json_document(...)` (same contract for in-memory PSA content)
9696

9797
See `include/psa.h` for full API details and record structures.
98+
99+
## Versioning and Compatibility
100+
101+
- Current release target: `v0.1.0`.
102+
- API/ABI compatibility for `0.x` releases is best effort and may evolve based on implementation feedback.
103+
- Error code semantics (`PSA_OK`, `PSA_ERR_*`) are intended to remain stable across minor releases.
104+
- Production consumers should pin to a specific tag or commit.

‎docs/bindings.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,5 @@ If your application wants display-specific normalization (for example, convertin
112112
- Keep your binding layer thin and faithful to C behavior.
113113
- Perform optional transformations in a separate higher-level layer.
114114
- Pin against a specific library version/commit in production.
115+
116+
For `0.x` releases, API/ABI stability is best effort while the library matures.

‎docs/spec/00-file-format-and-parser-flow.md‎

Lines changed: 0 additions & 88 deletions
This file was deleted.

‎docs/spec/01-project-record.md‎

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎docs/spec/02-planogram-record.md‎

Lines changed: 0 additions & 93 deletions
This file was deleted.

‎docs/spec/03-fixture-record.md‎

Lines changed: 0 additions & 56 deletions
This file was deleted.

0 commit comments

Comments
 (0)