Skip to content

Commit

Permalink
Merge pull request #183 from FabijanC/fix-version
Browse files Browse the repository at this point in the history
Fix versions in spec files and package.json (#183)
  • Loading branch information
ArielElp authored Dec 7, 2023
2 parents 06ea3b7 + adb549f commit 4966593
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
12 changes: 7 additions & 5 deletions api/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,19 @@ 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.

## 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.

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 <VERSION> --no-git-tag-version
```

## Technical Implementation

Expand All @@ -56,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.



2 changes: 1 addition & 1 deletion api/starknet_trace_api_openrpc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openrpc": "1.0.0-rc1",
"info": {
"version": "0.5.0",
"version": "0.6.0",
"title": "StarkNet Trace API",
"license": {}
},
Expand Down
2 changes: 1 addition & 1 deletion api/starknet_write_api.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openrpc": "1.0.0-rc1",
"info": {
"version": "0.5.0",
"version": "0.6.0",
"title": "StarkNet Node Write API",
"license": {}
},
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -16,4 +16,4 @@
"fs-extra": "10.1.0",
"@json-schema-tools/dereferencer": "1.5.4"
}
}
}

0 comments on commit 4966593

Please sign in to comment.