Add a semantic version for WAMR #1374

lum1n0us · 2022-08-11T02:21:15Z

before publish a release

manually change the content of config_common.cmake
or pass the new version by cmake -DWAMR_VERSION_MAJOR=XXX -DWAMR_VERSION_MINOR=YYY -DWAMR_VERSION_PATCH=ZZZ ...

core/iwasm/common/wasm_runtime_common.c

core/iwasm/include/wasm_export.h

core/version.h

core/version.h.in

build-scripts/config_common.cmake

product-mini/platforms/linux-sgx/enclave-sample/App/App.cpp

product-mini/platforms/posix/main.c

product-mini/platforms/windows/main.c

core/version.h.in

product-mini/platforms/linux-sgx/enclave-sample/App/App.cpp

product-mini/platforms/posix/main.c

yamt · 2022-08-15T06:14:25Z

what's included in our public api and what's not?

lum1n0us · 2022-08-15T10:45:39Z

what's included in our public api and what's not?

WASM_RUNTIME_API_EXTERN void
wasm_runtime_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);

yamt · 2022-08-15T11:36:23Z

what's included in our public api and what's not?

WASM_RUNTIME_API_EXTERN void
wasm_runtime_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);

my question was about the following.

https://semver.org/#semantic-versioning-specification-semver

Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it SHOULD be precise and comprehensive.

lum1n0us · 2022-08-16T01:36:12Z

what's included in our public api and what's not?
WASM_RUNTIME_API_EXTERN void
wasm_runtime_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);
my question was about the following.

https://semver.org/#semantic-versioning-specification-semver

Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it SHOULD be precise and comprehensive.

thansk for reminding. IIUC wasm_runtime_get_version is the API the question about and the API the semantic versioning required.

wamr-compiler/main.c

product-mini/platforms/linux-sgx/enclave-sample/Enclave/Enclave.cpp

yamt · 2022-08-16T03:53:15Z

what's included in our public api and what's not?
WASM_RUNTIME_API_EXTERN void
wasm_runtime_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);
my question was about the following.
https://semver.org/#semantic-versioning-specification-semver

Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it SHOULD be precise and comprehensive.
thansk for reminding. IIUC wasm_runtime_get_version is the API the question about and the API the semantic versioning required.

i think we are talking past each other.
wasm_runtime_get_version is not my concern.

to maintain semantic version properly, it's necessary to declare what kind of compatibility we guarantee to users. it's called "public api." (i think it's a semantic version term)
we bump our major version when we made incompatible changes to our public api.

do we care ABI? or only care API?
we occasionally breaks the ABI of wasm_export.h. (eg. whenever we extend RuntimeInitArgs) does it warrant a major bump?
how about wasm_c_api.h?
how about AoT runtime ABI?

yamt · 2022-08-17T05:08:35Z

doc/semantic_version.md

+## Legacy versions
+
+All legacy versions(tags) will keep their current status. We treat the first releasing,
+_WAMR-11-28-2019_, as the version 1.0.0, and so on.


what's the point to assign semver to old releases?

Just in case somebody is interested in why our next release would be 1.20.0

FYI, we won't change any existing release names or links.

yamt · 2022-08-17T05:11:06Z

doc/semantic_version.md

+There are three parts in the new version string:
+
+- _major_. WAMR only changes _major_ when APIs are modified in an incompatible way.
+  APIs includes: `wasm_export.h`, `wasm_c_api.h`, _sections in AOT files_, and so on.


APIs includes: wasm_export.h, wasm_c_api.h

does this mean ABI changes are not relevant?

sections in AOT files

what do you mean?

Our APIs do not just include headers but also AOT internal structures, like section headers, offsets, fields, and so on.

Both ABI and API matter.

Both ABI and API matter.

it's confusing because all legacy releases below share the major 1, while there were actually abi-breaking changes.

my suggestion is

simply start from 1.0.0

just say "pre-1.0.0 releases don't follow semver convention"

before publish a release - manually change the content of config_common.cmake - or pass new version by `cmake -DWAMR_VERSION_MAJOR=XXX -DWAMR_VERSION_MINOR=YYY -DWAMR_VERSION_PATCH=ZZZ ...` There is [a table](doc/legacy_versions.md) which semantic version string a legacy release should have Now, `iwasm --version` is able to return the version number, like "Wasm-Micro-Runtime v1.20.0".

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

bonifaido · 2022-09-02T13:51:22Z

So the next release will be cut according to SemVer? When can we expect it?

wenyongh · 2022-09-11T12:02:18Z

@bonifaido We have created the new release WAMR-1.0.0, hope it is helpful to you, thanks.

bonifaido · 2022-09-12T10:29:56Z

This is great! Thank you!

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

lum1n0us force-pushed the semantic_version branch 2 times, most recently from db890e8 to 0c490a2 Compare August 12, 2022 01:25

lum1n0us mentioned this pull request Aug 12, 2022

Homebrew formula #1357

Closed

bonifaido mentioned this pull request Aug 12, 2022

wasm-micro-runtime 1.0.0 (new formula) Homebrew/homebrew-core#107301

Closed

6 tasks

wenyongh reviewed Aug 12, 2022

View reviewed changes

lum1n0us force-pushed the semantic_version branch 3 times, most recently from 246d3d3 to b72ae9f Compare August 15, 2022 00:58

wenyongh reviewed Aug 15, 2022

View reviewed changes

lum1n0us force-pushed the semantic_version branch from b72ae9f to f734531 Compare August 15, 2022 10:43

lum1n0us force-pushed the semantic_version branch from f734531 to 880d7d5 Compare August 15, 2022 11:07

lum1n0us force-pushed the semantic_version branch from 880d7d5 to cff82a1 Compare August 16, 2022 01:37

wenyongh reviewed Aug 16, 2022

View reviewed changes

wamr-compiler/main.c Outdated Show resolved Hide resolved

wenyongh reviewed Aug 16, 2022

View reviewed changes

wamr-compiler/main.c Outdated Show resolved Hide resolved

lum1n0us force-pushed the semantic_version branch 2 times, most recently from 7c67fb6 to 89da5c7 Compare August 16, 2022 01:48

lum1n0us marked this pull request as ready for review August 16, 2022 01:48

wenyongh reviewed Aug 16, 2022

View reviewed changes

product-mini/platforms/linux-sgx/enclave-sample/Enclave/Enclave.cpp Outdated Show resolved Hide resolved

lum1n0us force-pushed the semantic_version branch from 89da5c7 to bbd4efa Compare August 16, 2022 01:59

lum1n0us force-pushed the semantic_version branch from bbd4efa to 5c48994 Compare August 17, 2022 01:22

yamt reviewed Aug 17, 2022

View reviewed changes

lum1n0us force-pushed the semantic_version branch from 5c48994 to 21f1627 Compare August 17, 2022 07:50

lum1n0us force-pushed the semantic_version branch from 21f1627 to 03bec7c Compare August 18, 2022 08:18

wenyongh merged commit 717e8a4 into bytecodealliance:main Aug 18, 2022

lum1n0us deleted the semantic_version branch October 1, 2022 11:41

Add a semantic version for WAMR #1374

Add a semantic version for WAMR #1374

Uh oh!

Conversation

lum1n0us commented Aug 11, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yamt commented Aug 15, 2022

Uh oh!

lum1n0us commented Aug 15, 2022

Uh oh!

yamt commented Aug 15, 2022

Uh oh!

lum1n0us commented Aug 16, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yamt commented Aug 16, 2022

Uh oh!

yamt Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

lum1n0us Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

lum1n0us Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

yamt Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

lum1n0us Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

yamt Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

yamt Aug 17, 2022

Choose a reason for hiding this comment

Uh oh!

bonifaido commented Sep 2, 2022

Uh oh!

wenyongh commented Sep 11, 2022

Uh oh!

bonifaido commented Sep 12, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants