WasmEdge Release Process
Create the releasing process issue of the new version
- Keep adding the new features, issues, documents, and builds check list into the issue.
- Add the GitHub project of the new version.
Write Changelog
- Make sure every change is written in the changelog.
-
Make sure the
Changelog.md
has the correct version number and the release date. -
Copy the changelog of this version to
.CurrentChangelog.md
. (Our release CI will take this file as the release notes.) - Record the contributor lists.
- Create a pull request, make sure the CI are all passed, and merge it.
Create the Alpha Pre-Release
- In this step, the main features are completed. No more major feature will be merged after the first Alpha pre-release.
- Make sure that the features in the releasing process issue are completed.
-
Use git tag to create a new release tag
major.minor.patch-alpha.version
. And push this tag to GitHub. - Wait for the CI builds and pushes the release binaries and release notes to the GitHub release page.
-
Check the
Pre-release
checkbox and publish the pre-release. - This step will automatically close and turn into Beta or RC phase in about 3 days if there's no critical issues.
Create the Beta Pre-Release
- This step is for the issue fixing if needed. No more feature will be accepted.
- Make sure that all the features in the releasing process issue are completed.
-
Use git tag to create a new release tag
major.minor.patch-beta.version
. And push this tag to GitHub. - Wait for the CI builds and pushes the release binaries and release notes to the GitHub release page.
-
Check the
Pre-release
checkbox and publish the pre-release. - This step will automatically close and turn into RC phase in about 3 days if there's no critical issues.
Create the RC Pre-Release
-
In this step, the issue fixing is finished. The
RC
pre-releases are for the installation, bindings, and packages testing. - Make sure that all the issues in the releasing process issue are completed.
-
Update
WASMEDGE_CAPI_VERSION
inCMakeLists.txt
. -
Update
wasmedge_version
indocs/book/en/book.toml
. -
Use git tag to create a new release tag
major.minor.patch-rc.version
. And push this tag to GitHub. - Wait for the CI builds and pushes the release binaries and release notes to the GitHub release page.
-
Check the
Pre-release
checkbox and publish the pre-release. - This step will automatically close and announce the official release in about 3 days if there's no critical issues.
Create the Official Release
-
Make sure the
Changelog.md
and.CurrentChangelog.md
have the correct version number and the release date. -
Use git tag to create a new release tag
major.minor.patch
. And push this tag to GitHub. - Wait for the CI builds and push the release binaries and release notes to the GitHub release page.
- Publish the release.
- Close the releasing process issue and the GitHub project.
Update the Extensions
The following projects will be updated with the Alpha
, Beta
, and RC
pre-releases and the official release: