[Doc] Add versioning_policy doc #62
Open
+113
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Yikun
force-pushed
the
release-policy
branch
3 times, most recently
from
f003f59 to
ae0fbc9
Compare
Yikun
force-pushed
the
release-policy
branch
4 times, most recently
from
1273e76 to
62eb0ed
Compare
Signed-off-by: Yikun Jiang <[email protected]>
Yikun
force-pushed
the
release-policy
branch
from
62eb0ed to
3891949
Compare
wangxiyuan
reviewed
Feb 16, 2025
| - **Final releases**: will typically be released every **3 months**, will take the vLLM upstream release plan and Ascend software product release plan into comprehensive consideration. | ||
| - **Pre releases**: will typically be released **on demand**, ending with rcN, represents the Nth release candidate version, to support early testing by our users prior to a final release. | ||
| - **Post releases**: will typically be released **on demand** to support to address minor errors in a final release. It's different from [PEP-440 post release note](https://peps.python.org/pep-0440/#post-releases) suggestion, it will contain actual bug fixes considering that the final release version should be matched strictly with the vLLM final release version (`v[major].[minor].[micro]`). The post version has to be published as a patch version of the final release. | ||
| - **Developmental releases**: will be tagged on demand before a final/pre/post releases to help create early releases directly from source code to help with iterative development and verification, typically will not be published to PyPI. |
There was a problem hiding this comment.
Not sure if dev tag is needed. More tag will lead more user confusion
|
|
||
| Note that vllm-ascend will only be released for a certain vLLM release version rather than all versions. Hence, You might see only part of versions have dev branches (such as only `0.7.1-dev` / `0.7.3-dev` but no `0.7.2-dev`), this is as expected. | ||
|
|
||
| Usually, a commit should be ONLY first merged in the main branch, and then backported to the dev branch to reduce maintenance costs as much as possible. |
There was a problem hiding this comment.
we should also describe the retire policy of a dev branch. For example, there only exists 2-3 dev branch, the oldest one will be removed once more branch is coming?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it?
This patch add the versioning policy doc for vllm-ascend
Does this PR introduce any user-facing change?
No
How was this patch tested?
preview: https://vllm-ascend--62.org.readthedocs.build/en/62/