From 82e84e4efb205777c52bfc180a2b85538e9342a6 Mon Sep 17 00:00:00 2001 From: Raphael Nestler Date: Tue, 31 Dec 2024 17:29:58 +0100 Subject: [PATCH 1/3] Add release instructions to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index fd6f7a8..e08a996 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,15 @@ ![Validate formatting](https://github.com/SpaceApi/schema/workflows/Validate%20formatting/badge.svg?event=push) These are [JSON Schema](https://json-schema.org/) files for the SpaceAPI. + +## Releasing a new version + + * Rename the current `xx-draft.json` to `xx.json` + * Replace the `"$id"` field accordingly + * Replace the `"description"` field accordingly + * Update the website + * Regenerate the schema docs + * Update the example + * Update the validator + * Update the schema in https://github.com/spaceapi-community/go-spaceapi-validator and release a new version + * Update the go-spaceapi-validator version in https://github.com/SpaceApi/validator/ From 5ecccdb6d135674271e23e36de8e3002ff3e15ff Mon Sep 17 00:00:00 2001 From: Raphael Nestler Date: Tue, 31 Dec 2024 17:37:41 +0100 Subject: [PATCH 2/3] Also update CHANGELOG, MIGRATION and the github workflows --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e08a996..c4fa4df 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,12 @@ These are [JSON Schema](https://json-schema.org/) files for the SpaceAPI. ## Releasing a new version - * Rename the current `xx-draft.json` to `xx.json` + * Make sure the `CHANGELOG.md` is up to date + * Update `MIGRATION.md` with upgrade instructions + * Rename the current `xx-draft.json` to `xx.json` and create `xx+1-draft.json` * Replace the `"$id"` field accordingly * Replace the `"description"` field accordingly + * Update the `.github/workflows` accordingly * Update the website * Regenerate the schema docs * Update the example From 1179e4df4bb34837c83e07f61b9a05cd8c499860 Mon Sep 17 00:00:00 2001 From: Raphael Nestler Date: Tue, 31 Dec 2024 17:45:36 +0100 Subject: [PATCH 3/3] Also update the api_compatibility value --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c4fa4df..3a71627 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ These are [JSON Schema](https://json-schema.org/) files for the SpaceAPI. * Rename the current `xx-draft.json` to `xx.json` and create `xx+1-draft.json` * Replace the `"$id"` field accordingly * Replace the `"description"` field accordingly + * Replace the `"properties"."api_compatibility"."contains"."const"` accordingly * Update the `.github/workflows` accordingly * Update the website * Regenerate the schema docs