wasm-micro-runtime/doc/semantic_version.md
liang.he 717e8a48e2
Enable the semantic version mechanism for WAMR (#1374)
Use the semantic versioning (https://semver.org) to replace the current date
versioning system, which is more general and is requested by some developers,
e.g. issue #1357.

There are three parts in the new version string:
- major. Any incompatible modification on ABIs and APIs will lead to an increment
  in the value of major, which mainly includes: AOT calling conventions, AOT file
  format, wasm_export.h, wasm_c_api.h, and so on.
- minor. It represents new features, including MVP/POST-MVP features, libraries,
  WAMR private ones, and so one.
- patch. It represents patches.

The new version will start from 1.0.0. Update the help info and version showing for
iwasm and wamrc.
2022-08-18 19:01:05 +08:00

22 lines
736 B
Markdown

# WAMR uses semantic versioning
WAMR uses the _semantic versioning_ to replace the current _date versioning_ system.
There are three parts in the new version string:
- _major_. Any incompatible modification, on both ABI and APIs, will lead an increment
in the value of _major_. APIs includes: `wasm_export.h`, `wasm_c_api.h`,
_sections in AOT files_, and so on.
- _minor_. It represents new features. It includes not just MVP or POST-MVP features
but also WASI features and WAMR private ones.
- _patch_. It represents patches.
## Legacy versions
All legacy versions(tags) will keep their current status. No existed releasings names
and links will be changed.
## Reference
- [Semantic Versioning 2.0.0](https://semver.org/)