Skip to content

[doc] ci: move doc annotation check to python 3.12 #58507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aslonnie merged 1 commit into from
Nov 10, 2025
Merged

[doc] ci: move doc annotation check to python 3.12 #58507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions .buildkite/doc.rayci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ steps:
- doc
- skip-on-premerge

- label: ":book: doc: check python API: {{matrix}}"
- label: ":book: doc: check API annotations"
tags:
- oss
- python
Expand All @@ -51,15 +51,35 @@ steps:
- rllib
- rllib_gpu
- doc
key: lint-medium
key: doc_api_annotations
instance_type: medium
depends_on: docbuild
job_env: docbuild-py3.12
commands:
- bash ci/lint/lint.sh api_annotations

- label: ":book: doc: check API doc consistency"
tags:
- oss
- python
- dashboard
- ray_client
- data
- serve
- ml
- tune
- train
- llm
- rllib
- rllib_gpu
- doc
Comment on lines +62 to +75
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 10, 2025

Choose a reason for hiding this comment

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

medium

This list of tags is identical to the tags for the :book: doc: check API annotations job. To improve maintainability and avoid having to update tags in two places, you can use a YAML anchor here. The other job can then be updated in a follow-up to use a YAML alias to reference this list. This will make future changes to these tags easier to manage.

    tags: &doc_check_tags
      - oss
      - python
      - dashboard
      - ray_client
      - data
      - serve
      - ml
      - tune
      - train
      - llm
      - rllib
      - rllib_gpu
      - doc

key: doc_api_policy_check
instance_type: medium
depends_on: docbuild
# TODO(aslonnie): migrate to Python 3.12
job_env: docbuild-py3.9
commands:
- ./ci/lint/lint.sh {{matrix}}
matrix:
- api_annotations
- api_policy_check
- bash ci/lint/lint.sh api_policy_check

- label: ":book: doc: linkcheck"
instance_type: medium
Expand Down