Skip to content

Enhance linting setup and clarify SchedulingPolicy documentation - #696

Merged
gaius-qi merged 3 commits into
mainfrom
feature/doc
Nov 5, 2026
Merged

gaius-qi merged 3 commits into
mainfrom
feature/doc

Conversation

@gaius-qi

@gaius-qi gaius-qi commented Nov 5, 2026

Copy link
Copy Markdown
Member

Description

This pull request updates the download scheduling policy logic and ensures the Go environment is properly set up in the CI workflow. The most significant changes clarify when downloads should bypass the scheduler and improve the reliability of Go-based linting in CI.

Scheduling Policy Documentation Updates:

  • Updated the SchedulingPolicy comments in both proto/common.proto and src/common.v2.rs to specify that downloads will bypass the scheduler if the content length or range length is less than or equal to 16MiB, instead of referencing the minimum piece length. This change clarifies the conditions under which direct downloads occur. [1] [2]

CI Workflow Improvements:

  • Added a new step to the .github/workflows/lint.yml workflow to set up the Go environment using the actions/setup-go@v7 action, ensuring the correct Go version from go.mod is used during linting.

Related Issue

Motivation and Context

Add an actions/setup-go step to the lint workflow so the Go toolchain
version matches the one declared in go.mod instead of relying on the
runner's default, avoiding version mismatches during linting.

Signed-off-by: Gaius <gaius.qi@gmail.com>
Reword the AUTO and ALWAYS comments so AUTO states that downloads bypass
the scheduler when the content length or range length is at most 16MiB,
replacing the vague "smaller than the minimum piece length" wording. The
ALWAYS description is simplified to "even for small files". Generated Go
and Rust bindings are regenerated to match the proto.

Signed-off-by: Gaius <gaius.qi@gmail.com>
… length

Update the SchedulingPolicy enum comments to describe the direct-download
threshold in terms of the minimum piece length instead of a hardcoded
16MiB content/range length. Regenerate the descriptor accordingly. No
functional behavior changes.

Signed-off-by: Gaius <gaius.qi@gmail.com>
@gaius-qi gaius-qi self-assigned this Nov 5, 2026
@gaius-qi
gaius-qi requested a review from a team as a code owner November 5, 2026 06:19
@gaius-qi gaius-qi added the enhancement New feature or request label Nov 5, 2026
@gaius-qi
gaius-qi requested a review from a team as a code owner November 5, 2026 06:19
@gaius-qi
gaius-qi enabled auto-merge (squash) November 5, 2026 06:20

@CormickKneey CormickKneey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Lint workflow now pins Go from go.mod, and SchedulingPolicy AUTO/ALWAYS comments match the ≤16MiB content/range bypass used in client. Generated bindings look consistent. No functional concerns.

@gaius-qi
gaius-qi merged commit 0cfda6a into main Nov 5, 2026
6 checks passed
@gaius-qi
gaius-qi deleted the feature/doc branch November 5, 2026 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants