From abcb97f5850daca106d830bd36b381d4363f67ef Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 18:37:41 +0800 Subject: add versioning policy --- README | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'README') diff --git a/README b/README index 7c9e147..1d0a60b 100644 --- a/README +++ b/README @@ -7,3 +7,24 @@ metadata, set the bucket name in the `R2_BUCKET` environment variable and specify the release tag with `TAG`, then run the Makefile target: R2_BUCKET= TAG= make deploy + + +Versioning +---------- + +This package follows the version format `MAJOR.MINOR.YYYYMMDD`. + +The patch component uses a date instead of an incrementing number to +make the freshness of the metadata immediately visible. + +- **Major** version increments indicate breaking changes to the metadata + schema. +- **Minor** version increments indicate backward-compatible changes to + the metadata schema. +- **Patch** version represents the metadata snapshot date in `YYYYMMDD` + format and indicates when the metadata was generated from Alibaba + Cloud. + +Consumers should depend on `^MAJOR.MINOR`, for example: + + "lizhineng/afterglow-metadata": "^1.0" -- cgit v1.2.3