docs: update release notes and docs for v1.1.0 - #6145
Open
cheyang wants to merge 1 commit into
Open
Conversation
Add the v1.1.0 section to CHANGELOG.md, following the existing
Highlights / Enhancements / Bug Fixes structure and adding a
Deprecations and Removals section for the GooseFSRuntime removal.
The headline of this release is CacheRuntime: the new CacheRuntime and
CacheRuntimeClass CRDs let a cache system be onboarded declaratively
instead of by writing a new Go engine, with Curvine as the first
integration.
Also:
- add a v1.1.0 row to the news table in both READMEs, dropping the
oldest entry to keep the customary three releases
- index docs/{en,zh}/userguide/cache_runtime_tieredstore.md in both
TOCs, which was previously unreachable from the table of contents
The release date is left as TBD and needs to be filled in when the
tag is cut.
Signed-off-by: cheyang <cheyang.cy@alibaba-inc.com>
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #6145 +/- ##
=======================================
Coverage 65.10% 65.10%
=======================================
Files 485 485
Lines 34015 34015
=======================================
Hits 22147 22147
Misses 10127 10127
Partials 1741 1741 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Ⅰ. Describe what this PR does
Documentation-only preparation for the v1.1.0 release. The version and chart bumps already landed in #5305; this PR fills in the release notes and the docs that reference the release.
CHANGELOG.md— adds the v1.1.0 section, following the existingHighlights/Enhancements/Bug Fixesstructure, plus a newDeprecations and Removalssection. Distilled from the 489 commits sincev1.0.8.The headline of the release is CacheRuntime: the new
CacheRuntimeandCacheRuntimeClassCRDs let a cache system be onboarded declaratively — by describing its topology (MasterSlave/P2P-DHT/ClientOnly), per-component workload form and operation commands — instead of writing a new Go engine. Curvine is the first system integrated through the framework.README.md/README-zh_CN.md— adds a v1.1.0 row to the news table, dropping the oldest entry to keep the customary three release rows (same as was done when v1.0.8 was tagged).docs/{en,zh}/TOC.md— indexesuserguide/cache_runtime_tieredstore.md, a v1.1.0 feature doc that exists in both languages but was not reachable from either table of contents. Placed under Advanced / 进阶使用, right after the Alluxio tiered store entry.Ⅱ. Does this pull request fix one issue?
NONE
Ⅲ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
No tests needed — this PR only changes Markdown files and adds no code.
Ⅳ. Describe how to verify it
CHANGELOG.mdresolve to files that exist in the tree (generic_cache_runtime_integration.md,cacheruntime_spec_update.md,ROADMAP.md), as do the two new TOC entries.api/v1alpha1/cacheruntime_types.go,api/v1alpha1/cacheruntimeclass_types.goandconfig/crd/bases/data.fluid.io_cacheruntime{,class}es.yaml.Ⅴ. Special notes for reviews
Two things worth a reviewer's attention:
The release date is deliberately left as
TBD— in theCHANGELOG.mdheading and in both README news rows. It needs to be filled in when the tag is actually cut:grep -n TBD CHANGELOG.md README.md README-zh_CN.md.Graceful scale-down for AlluxioRuntime via AdvancedStatefulSet (feat: support graceful scale-down for AlluxioRuntime using AdvancedStatefulSet #5805) is intentionally not listed. Its commit message is prefixed
feat:and it reads like a highlight, but Revert "feat: support graceful scale-down for AlluxioRuntime" (#5805) #6059 reverted it in full, so the feature is not in v1.1.0. Generating release notes straight from thefeat:list would have wrongly advertised it.Please double-check the
Deprecations and Removalsentry: GooseFSRuntime removal (#5703) is called out as requiring migration before upgrading, since it is the only breaking change in this release. If the intended messaging around GooseFS is softer or stronger, that line should be adjusted.