Skip to content

pin ruff commit hashes when copying docs #1636

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

Open
oconnor663 wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −4
Open

pin ruff commit hashes when copying docs #1636

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e453278
pin ruff commit hashes when copying docs
oconnor663 Nov 25, 2025
ad82b62
Codex is right
oconnor663 Nov 25, 2025
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
17 changes: 13 additions & 4 deletions scripts/autogenerate_files.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,23 @@ set -eu
script_root="$(realpath "$(dirname "$0")")"
project_root="$(dirname "$script_root")"
cd "$project_root"
ruff_commit="$(git -C ruff rev-parse HEAD)"

echo "Updating lockfile..."
uv lock

echo "Copying reference documentation from Ruff..."
cp ./ruff/crates/ty/docs/cli.md ./docs/reference/
cp ./ruff/crates/ty/docs/configuration.md ./docs/reference/
cp ./ruff/crates/ty/docs/rules.md ./docs/reference/
cp ./ruff/crates/ty/docs/environment.md ./docs/reference/
copy_docs() {
src="$1"
dest="$2"
[ -d "$dest" ] && dest="$dest/$(basename "$src")"
old_url="/github.com/astral-sh/ruff/blob/main/"
new_url="/github.com/astral-sh/ruff/blob/$ruff_commit/"
sed "s|$old_url|$new_url|g" "$src" > "$dest"
}
copy_docs ./ruff/crates/ty/docs/cli.md ./docs/reference/
copy_docs ./ruff/crates/ty/docs/configuration.md ./docs/reference/
copy_docs ./ruff/crates/ty/docs/rules.md ./docs/reference/
Copy link
Copy Markdown
Member

@MichaReiser MichaReiser Nov 26, 2025

Choose a reason for hiding this comment

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

I think we only need this for rules.md, no other markdown file contains line-references

copy_docs ./ruff/crates/ty/docs/environment.md ./docs/reference/

echo "Documentation has been copied from Ruff submodule"
Loading