From 10c3baf169f374d4d0118eb2be14101187ffc33c Mon Sep 17 00:00:00 2001 From: FabijanC Date: Thu, 7 Dec 2023 12:50:58 +0100 Subject: [PATCH 1/2] Fix versions --- api/release.md | 8 +++++++- api/starknet_trace_api_openrpc.json | 2 +- api/starknet_write_api.json | 2 +- package-lock.json | 10 +++++----- package.json | 6 +++--- 5 files changed, 17 insertions(+), 11 deletions(-) diff --git a/api/release.md b/api/release.md index d6d2215..358c2dd 100644 --- a/api/release.md +++ b/api/release.md @@ -33,10 +33,16 @@ Suggestions to API specification changes are made as pull requests on the master ## Version Numbering -Release follow a [semantic versioning](semver.org) for version tags. +Releases follow [semantic versioning](https://semver.org) for version tags. We use `rc`_i_ ( i = 1,2,...) suffix to qualify different release candidates. No suffix to a version means it's the recommendation version. +When updating the specification version, change the `"version"` property in all of the specification files. Also update the version in `package*.json` files by running: + +``` +npm version --no-git-tag-version +``` + ## Different Specification Documents A release number is relevant to all API specification documents at the same time. In other words, they are all considered a single document. diff --git a/api/starknet_trace_api_openrpc.json b/api/starknet_trace_api_openrpc.json index 3b7c447..06ae5ba 100644 --- a/api/starknet_trace_api_openrpc.json +++ b/api/starknet_trace_api_openrpc.json @@ -1,7 +1,7 @@ { "openrpc": "1.0.0-rc1", "info": { - "version": "0.5.0", + "version": "0.6.0", "title": "StarkNet Trace API", "license": {} }, diff --git a/api/starknet_write_api.json b/api/starknet_write_api.json index 84a7221..63f5c3b 100644 --- a/api/starknet_write_api.json +++ b/api/starknet_write_api.json @@ -1,7 +1,7 @@ { "openrpc": "1.0.0-rc1", "info": { - "version": "0.5.0", + "version": "0.6.0", "title": "StarkNet Node Write API", "license": {} }, diff --git a/package-lock.json b/package-lock.json index 6c8fd3b..1821809 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "openrpc_scripts", - "version": "0.1.0", + "name": "starknet_specs", + "version": "0.6.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "openrpc_scripts", - "version": "0.1.0", + "name": "starknet_specs", + "version": "0.6.0", "license": "MIT", "dependencies": { "@json-schema-tools/dereferencer": "1.5.4", @@ -443,4 +443,4 @@ } } } -} +} \ No newline at end of file diff --git a/package.json b/package.json index f60c7e0..9e4d38c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "openrpc_scripts", - "version": "0.1.0", + "name": "starknet_specs", + "version": "0.6.0", "description": "Tooling for OpenRPC files", "repository": { "type": "git", @@ -16,4 +16,4 @@ "fs-extra": "10.1.0", "@json-schema-tools/dereferencer": "1.5.4" } -} +} \ No newline at end of file From adb549f948d8c6550f94da33ef28c5faedbf9795 Mon Sep 17 00:00:00 2001 From: FabijanC Date: Thu, 7 Dec 2023 12:59:09 +0100 Subject: [PATCH 2/2] Update docs --- api/release.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/api/release.md b/api/release.md index 358c2dd..dfe07af 100644 --- a/api/release.md +++ b/api/release.md @@ -37,17 +37,16 @@ Releases follow [semantic versioning](https://semver.org) for version tags. We use `rc`_i_ ( i = 1,2,...) suffix to qualify different release candidates. No suffix to a version means it's the recommendation version. -When updating the specification version, change the `"version"` property in all of the specification files. Also update the version in `package*.json` files by running: +## Different Specification Documents + +A release number is relevant to all API specification documents at the same time. In other words, they are all considered a single document. + +When updating the specification version, change the `"version"` property in all specification files. Also update the version in `package*.json` files by running: ``` npm version --no-git-tag-version ``` -## Different Specification Documents - -A release number is relevant to all API specification documents at the same time. In other words, they are all considered a single document. -Some parts of the API, e.g. the trace API, are considered optional. Still, they affect and adhere to the semantic version of the release. - ## Technical Implementation We use github releases on this repo to publish releases. @@ -62,6 +61,3 @@ Examples for tags: - `v0.1.0-rc1`: release candidate 1 of version 0.1.0. - `v1.0.0`: First recommended release of the API - `v1.1.0-rc2`: 2nd release candidate for the release that has non-breaking changes over the first recommended release. - - -