https://wasmedge.org/docs/assets/js/338d3fa8.abfc8750.js

1"use strict";(self.webpackChunkbook=self.webpackChunkbook||[]).push([[5668],{3905:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>h});var i=a(67294);function s(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,i)}return a}function r(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){s(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function n(e,t){if(null==e)return{};var a,i,s=function(e,t){if(null==e)return{};var a,i,s={},l=Object.keys(e);for(i=0;i<l.length;i++)a=l[i],t.indexOf(a)>=0||(s[a]=e[a]);return s}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i<l.length;i++)a=l[i],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(s[a]=e[a])}return s}var c=i.createContext({}),o=function(e){var t=i.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):r(r({},t),e)),a},p=function(e){var t=o(e.components);return i.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var a=e.components,s=e.mdxType,l=e.originalType,c=e.parentName,p=n(e,["components","mdxType","originalType","parentName"]),d=o(a),k=s,h=d["".concat(c,".").concat(k)]||d[k]||m[k]||l;return a?i.createElement(h,r(r({ref:t},p),{},{components:a})):i.createElement(h,r({ref:t},p))}));function h(e,t){var a=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var l=a.length,r=new Array(l);r[0]=k;var n={};for(var c in t)hasOwnProperty.call(t,c)&&(n[c]=t[c]);n.originalType=e,n[d]="string"==typeof e?e:s,r[1]=n;for(var o=2;o<l;o++)r[o]=a[o];return i.createElement.apply(null,r)}return i.createElement.apply(null,a)}k.displayName="MDXCreateElement"},88333:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>m,frontMatter:()=>l,metadata:()=>n,toc:()=>o});var i=a(87462),s=(a(67294),a(3905));const l={sidebar_position:9},r="Release Process",n={unversionedId:"contribute/release",id:"contribute/release",title:"Release Process",description:"Create the releasing process issue of the new version",source:"@site/docs/contribute/release.md",sourceDirName:"contribute",slug:"/contribute/release",permalink:"/docs/contribute/release",draft:!1,editUrl:"https://github.com/wasmedge/docs/blob/main/docs/contribute/release.md",tags:[],version:"current",sidebarPosition:9,frontMatter:{sidebar_position:9},sidebar:"contributeSidebar",previous:{title:"Contributing Guide",permalink:"/docs/contribute/"},next:{title:"Join WasmEdge Community",permalink:"/docs/contribute/community"}},c={},o=[{value:"Create the releasing process issue of the new version",i

1d:"create-the-releasing-process-issue-of-the-new-version",level:2},{value:"Write Changelog",id:"write-changelog",level:2},{value:"Create the Alpha Pre-Release",id:"create-the-alpha-pre-release",level:2},{value:"Create the Beta Pre-Release",id:"create-the-beta-pre-release",level:2},{value:"Create the RC Pre-Release",id:"create-the-rc-pre-release",level:2},{value:"Create the Official Release",id:"create-the-official-release",level:2},{value:"Update the Extensions",id:"update-the-extensions",level:2}],p={toc:o},d="wrapper";function m(e){let{components:t,...a}=e;return(0,s.kt)(d,(0,i.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h1",{id:"release-process"},"Release Process"),(0,s.kt)("h2",{id:"create-the-releasing-process-issue-of-the-new-version"},"Create the releasing process issue of the new version"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Keep adding new features, issues, and documents, and builds a checklist into the issue."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Add the GitHub project of the new version.")),(0,s.kt)("h2",{id:"write-changelog"},"Write Changelog"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Make sure every change is written in the changelog."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Make sure the ",(0,s.kt)("inlineCode",{parentName:"li"},"Changelog.md")," has the correct version number and the release date."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Copy the changelog of this version to ",(0,s.kt)("inlineCode",{parentName:"li"},".CurrentChangelog.md"),". (Our release CI will take this file as the release notes.)"),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Record the contributor lists."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Create a pull request, make sure the CI is all passed, and merge it.")),(0,s.kt)("h2",{id:"create-the-alpha-pre-release"},"Create the Alpha Pre-Release"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","In this step, the main features are completed. No more major features will be merged after the first Alpha pre-release."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Make sure that the features in the releasing process issue are completed."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Use git tag to create a new release tag ",(0,s.kt)("inlineCode",{parentName:"li"},"major.minor.patch-alpha.version"),". And push this tag to GitHub."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Wait for the CI builds and pushes the release binaries and release notes to the GitHub release page."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Check the ",(0,s.kt)("inlineCode",{parentName:"li"},"Pre-release")," checkbox and publish the pre-release."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","This step will automatically close and turn into the Beta or RC phase in about 3 days if there are no critical issues.")),(0,s.kt)("h2",{id:"create-the-beta-pre-release"},"Create the Beta Pre-Release"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","This step is for the issue fixing if needed. No more features will be accepted."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Make sure all the features in the releasing process issue are completed."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Use git tag to create a new release tag ",(0,s.kt)("inlineCode",{parentName:"li"},"major.minor.patch-beta.version"),". And push this tag to GitHub."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Wait for the CI builds and pushes the release binaries and release notes to the GitHub release page."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Check the ",(0,s.kt)("inlineCode",{parentName:"li"},"Pre-release")," checkbox and publish the pre-release."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","This step will automatically close and turn into the RC phase in about 3 days if there are no critical issues.")),(0,s.kt)("h2",{id:"create-the-rc-pre-release"},"Create the RC Pre-Release"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","In this step, the issue fixing is finished. The ",(0,s.kt)("inlineCode",{parentName:"li"},"RC")," pre-releases are for installation, bindings, and package testing."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Make sure that all the issues in the release process issue are completed."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Update ",(0,s.kt)("inlineCode",{parentName:"li"},"WASMEDGE_CAPI_VERSION")," in ",(0,s.kt)("inlineCode",{parentName:"li"},"CMakeLists.txt"),"."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Update ",(0,s.kt)("inlineCode",{parentName:"li"},"wasmedge_version")," in ",(0,s.kt)("inlineCode",{parentName:"li"},"docs/.env"),"."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Use git tag to create a new release tag ",(0,s.kt)("inlineCode",{parentName:"li"},"major.minor.patch-rc.version"),". And push this tag to GitHub."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Wait for the CI builds and pushes the release binaries and release notes to the GitHub release page."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Check the ",(0,s.kt)("inlineCode",{parentName:"li"},"Pre-release")," checkbox and publish the pre-release."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","This step will automatically close and announce the official release in about three days if there are no critical issues.")),(0,s.kt)("h2",{id:"create-the-official-release"},"Create the Official Release"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Make sure the ",(0,s.kt)("inlineCode",{parentName:"li"},"Changelog.md"),", ",(0,s.kt)("inlineCode",{parentName:"li"},".CurrentChangelog.md")," and the ",(0,s.kt)("inlineCode",{parentName:"li"},"SECURITY.md")," have the correct version number and the release date."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Use git tag to create a new release tag ",(0,s.kt)("inlineCode",{parentName:"li"},"major.minor.patch"),". And push this tag to GitHub."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Wait for the CI builds and push the release binaries and release notes to the GitHub release page."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Publish the release."),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ","Close the releasing process issue and the GitHub project.")),(0,s.kt)("h2",{id:"update-the-extensions"},"Update the Extensions"),(0,s.kt)("p",null,"Following projects will be updated with the ",(0,s.kt)("inlineCode",{parentName:"p"},"Alpha"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"Beta"),", and ",(0,s.kt)("inlineCode",{parentName:"p"},"RC")," pre-releases and the official release:"),(0,s.kt)("ul",{className:"contains-task-list"},(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ",(0,s.kt)("a",{parentName:"li",href:"https://github.com/second-state/Wasm

1Edge-go"},"WasmEdge-Go SDK")),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ",(0,s.kt)("a",{parentName:"li",href:"https://github.com/second-state/wasmedge-core"},"WasmEdge-core NAPI package")),(0,s.kt)("li",{parentName:"ul",className:"task-list-item"},(0,s.kt)("input",{parentName:"li",type:"checkbox",checked:!1,disabled:!0})," ",(0,s.kt)("a",{parentName:"li",href:"https://github.com/second-state/wasmedge-extensions"},"WasmEdge-extensions NAPI package"))))}m.isMDXComponent=!0}}]);