Skip to content

Commit

Permalink
Apply doc change from starkware-libs#183
Browse files Browse the repository at this point in the history
  • Loading branch information
FabijanC committed Dec 7, 2023
1 parent 3e3c083 commit f0de5e2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions api/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ 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 of the specification files. Also update the version in `package*.json` files by running:

```
npm version <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.
Expand Down

0 comments on commit f0de5e2

Please sign in to comment.