GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-15 16:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: simplify bump_deps.lua

Browse Source 
Simplify usage and remove redundant flags and code.
This commit is contained in:
dundargoc
2025-01-12 13:10:48 +01:00
committed by dundargoc
parent e962167245
commit 27da6f7757
1 changed files with 104 additions and 371 deletions
Download Patch File Download Diff File Expand all files Collapse all files

475
scripts/bump_deps.lua
View File

@ -3,40 +3,45 @@
-- Usage:
-- ./scripts/bump_deps.lua -h
local M = {}
assert(vim.fn.executable('sed') == 1)
local _trace = false
local required_branch_prefix = 'bump-'
local commit_prefix = 'build(deps): '
-- Print message
local function p(s)
vim.cmd('set verbose=1')
vim.api.nvim_echo({ { s, '' } }, false, {})
vim.cmd('set verbose=0')
local repos = {
'luajit/luajit',
'libuv/libuv',
'luvit/luv',
'neovim/unibilium',
'juliastrings/utf8proc',
'tree-sitter/tree-sitter',
'tree-sitter/tree-sitter-c',
'tree-sitter-grammars/tree-sitter-lua',
'tree-sitter-grammars/tree-sitter-vim',
'neovim/tree-sitter-vimdoc',
'tree-sitter-grammars/tree-sitter-query',
'tree-sitter-grammars/tree-sitter-markdown',
'bytecodealliance/wasmtime',
'uncrustify/uncrustify',
}
local dependency_table = {} --- @type table<string, string>
for _, repo in pairs(repos) do
dependency_table[vim.fs.basename(repo)] = repo
end
local function die()
p('')
local function die(msg)
print(msg)
vim.cmd('cquit 1')
end
-- Executes and returns the output of `cmd`, or nil on failure.
-- if die_on_fail is true, process dies with die_msg on failure
--
-- Prints `cmd` if `trace` is enabled.
local function _run(cmd, die_on_fail, die_msg)
if _trace then
p('run: ' .. vim.inspect(cmd))
end
local rv = vim.trim(vim.fn.system(cmd)) or ''
local rv = vim.trim(vim.system(cmd, { text = true }):wait().stdout) or ''
if vim.v.shell_error ~= 0 then
if die_on_fail then
if _trace then
p(rv)
end
p(die_msg)
die()
die(die_msg)
end
return nil
end
@ -53,106 +58,19 @@ local function run_die(cmd, err_msg)
return _run(cmd, true, err_msg)
end
local function require_executable(cmd)
local cmd_path = run_die({ 'sh', '-c', 'command -v ' .. cmd }, cmd .. ' not found!')
run_die({ 'test', '-x', cmd_path }, cmd .. ' is not executable')
end
local function rm_file_if_present(path_to_file)
run({ 'rm', '-f', path_to_file })
end
local nvim_src_dir = vim.fn.getcwd()
local nvim_src_dir = run({ 'git', 'rev-parse', '--show-toplevel' })
local deps_file = nvim_src_dir .. '/' .. 'cmake.deps/deps.txt'
local temp_dir = nvim_src_dir .. '/tmp'
run({ 'mkdir', '-p', temp_dir })
local function get_dependency(dependency_name)
local dependency_table = {
['luajit'] = {
repo = 'LuaJIT/LuaJIT',
symbol = 'LUAJIT',
},
['libuv'] = {
repo = 'libuv/libuv',
symbol = 'LIBUV',
},
['luv'] = {
repo = 'luvit/luv',
symbol = 'LUV',
},
['unibilium'] = {
repo = 'neovim/unibilium',
symbol = 'UNIBILIUM',
},
['utf8proc'] = {
repo = 'JuliaStrings/utf8proc',
symbol = 'UTF8PROC',
},
['tree-sitter'] = {
repo = 'tree-sitter/tree-sitter',
symbol = 'TREESITTER',
},
['tree-sitter-c'] = {
repo = 'tree-sitter/tree-sitter-c',
symbol = 'TREESITTER_C',
},
['tree-sitter-lua'] = {
repo = 'tree-sitter-grammars/tree-sitter-lua',
symbol = 'TREESITTER_LUA',
},
['tree-sitter-vim'] = {
repo = 'tree-sitter-grammars/tree-sitter-vim',
symbol = 'TREESITTER_VIM',
},
['tree-sitter-vimdoc'] = {
repo = 'neovim/tree-sitter-vimdoc',
symbol = 'TREESITTER_VIMDOC',
},
['tree-sitter-query'] = {
repo = 'tree-sitter-grammars/tree-sitter-query',
symbol = 'TREESITTER_QUERY',
},
['tree-sitter-markdown'] = {
repo = 'tree-sitter-grammars/tree-sitter-markdown',
symbol = 'TREESITTER_MARKDOWN',
},
['wasmtime'] = {
repo = 'bytecodealliance/wasmtime',
symbol = 'WASMTIME',
},
['uncrustify'] = {
repo = 'uncrustify/uncrustify',
symbol = 'UNCRUSTIFY',
},
}
local dependency = dependency_table[dependency_name]
if dependency == nil then
p('Not a dependency: ' .. dependency_name)
die()
end
dependency.name = dependency_name
return dependency
end
local function get_gh_commit_sha(repo, ref)
require_executable('gh')
local sha = run_die(
{ 'gh', 'api', 'repos/' .. repo .. '/commits/' .. ref, '--jq', '.sha' },
'Failed to get commit hash from GitHub. Not a valid ref?'
)
return sha
end
--- @param repo string
--- @param ref string
local function get_archive_info(repo, ref)
require_executable('curl')
local temp_dir = os.getenv('TMPDIR') or os.getenv('TEMP')
local archive_name = ref .. '.tar.gz'
local archive_path = temp_dir .. '/' .. archive_name
local archive_url = 'https://github.com/' .. repo .. '/archive/' .. archive_name
rm_file_if_present(archive_path)
vim.fs.rm(archive_path, { force = true })
run_die(
{ 'curl', '-sL', archive_url, '-o', archive_path },
'Failed to download archive from GitHub'
@ -166,9 +84,7 @@ local function get_archive_info(repo, ref)
return { url = archive_url, sha = archive_sha }
end
local function write_cmakelists_line(symbol, kind, value)
require_executable('sed')
local function update_deps_file(symbol, kind, value)
run_die({
'sed',
'-i',
@ -178,290 +94,107 @@ local function write_cmakelists_line(symbol, kind, value)
}, 'Failed to write ' .. deps_file)
end
local function explicit_create_branch(dep)
require_executable('git')
local checked_out_branch = run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' })
if checked_out_branch ~= 'master' then
p('Not on master!')
die()
end
run_die({ 'git', 'checkout', '-b', 'bump-' .. dep }, 'git failed to create branch')
end
local function verify_branch(new_branch_suffix)
require_executable('git')
local checked_out_branch = assert(run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' }))
if not checked_out_branch:match('^' .. required_branch_prefix) then
p(
"Current branch '"
.. checked_out_branch
.. "' doesn't seem to start with "
.. required_branch_prefix
)
p('Checking out to bump-' .. new_branch_suffix)
explicit_create_branch(new_branch_suffix)
end
end
local function update_cmakelists(dependency, archive, comment)
require_executable('git')
verify_branch(dependency.name)
p('Updating ' .. dependency.name .. ' to ' .. archive.url .. '\n')
write_cmakelists_line(dependency.symbol, 'URL', archive.url:gsub('/', '\\/'))
write_cmakelists_line(dependency.symbol, 'SHA256', archive.sha)
run_die({
'git',
'commit',
deps_file,
'-m',
commit_prefix .. 'bump ' .. dependency.name .. ' to ' .. comment,
}, 'git failed to commit')
end
local function verify_cmakelists_committed()
require_executable('git')
local function ref(name, _ref)
local repo = dependency_table[name]
local symbol = string.gsub(name, 'tree%-sitter', 'treesitter'):gsub('%-', '_'):upper()
run_die(
{ 'git', 'diff', '--quiet', 'HEAD', '--', deps_file },
deps_file .. ' has uncommitted changes'
)
end
local function warn_luv_symbol()
p('warning: ' .. get_dependency('Luv').symbol .. '_VERSION will not be updated')
end
local full_repo = string.format('https://github.com/%s.git', repo)
-- `git ls-remote` returning empty string means provided ref is a regular commit hash and not a
-- tag nor HEAD.
local sha = vim.split(assert(run_die({ 'git', 'ls-remote', full_repo, _ref })), '\t')[1]
local commit_sha = sha == '' and _ref or sha
-- return first 9 chars of commit
local function short_commit(commit)
return string.sub(commit, 1, 9)
end
local archive = get_archive_info(repo, commit_sha)
local comment = string.sub(_ref, 1, 9)
-- TODO: remove hardcoded fork
local function gh_pr(pr_title, pr_body)
require_executable('gh')
local pr_url = run_die({
'gh',
'pr',
'create',
'--title',
pr_title,
'--body',
pr_body,
}, 'Failed to create PR')
return pr_url
end
local function find_git_remote(fork)
require_executable('git')
local remotes = assert(run({ 'git', 'remote', '-v' }))
local git_remote = ''
for remote in remotes:gmatch('[^\r\n]+') do
local words = {}
for word in remote:gmatch('%w+') do
table.insert(words, word)
end
local match = words[1]:match('/github.com[:/]neovim/neovim/')
if fork == 'fork' then
match = not match
end
if match and words[3] == '(fetch)' then
git_remote = words[0]
break
end
end
if git_remote == '' then
git_remote = 'origin'
end
return git_remote
end
local function create_pr(pr_title, pr_body)
require_executable('git')
local push_first = true
local checked_out_branch = run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' })
if push_first then
local push_remote =
run({ 'git', 'config', '--get', 'branch.' .. checked_out_branch .. '.pushRemote' })
if push_remote == nil then
push_remote = run({ 'git', 'config', '--get', 'remote.pushDefault' })
if push_remote == nil then
push_remote =
run({ 'git', 'config', '--get', 'branch.' .. checked_out_branch .. '.remote' })
if push_remote == nil or push_remote == find_git_remote(nil) then
push_remote = find_git_remote('fork')
end
end
end
p('Pushing to ' .. push_remote .. '/' .. checked_out_branch)
run_die({ 'git', 'push', push_remote, checked_out_branch }, 'Git failed to push')
local checked_out_branch = assert(run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' }))
if not checked_out_branch:match('^' .. required_branch_prefix) then
print(
"Current branch '"
.. checked_out_branch
.. "' doesn't seem to start with "
.. required_branch_prefix
)
print('Checking out to bump-' .. name)
run_die({ 'git', 'checkout', '-b', 'bump-' .. name }, 'git failed to create branch')
end
local pr_url = gh_pr(pr_title, pr_body)
p('\nCreated PR: ' .. pr_url .. '\n')
end
function M.commit(dependency_name, commit)
local dependency = assert(get_dependency(dependency_name))
verify_cmakelists_committed()
local commit_sha = get_gh_commit_sha(dependency.repo, commit)
if commit_sha ~= commit then
p('Not a commit: ' .. commit .. '. Did you mean version?')
die()
end
local archive = get_archive_info(dependency.repo, commit)
if dependency_name == 'Luv' then
warn_luv_symbol()
end
update_cmakelists(dependency, archive, short_commit(commit))
end
function M.version(dependency_name, version)
vim.validate('dependency_name', dependency_name, 'string')
vim.validate('version', version, 'string')
local dependency = assert(get_dependency(dependency_name))
verify_cmakelists_committed()
local commit_sha = get_gh_commit_sha(dependency.repo, version)
if commit_sha == version then
p('Not a version: ' .. version .. '. Did you mean commit?')
die()
end
local archive = get_archive_info(dependency.repo, version)
if dependency_name == 'Luv' then
write_cmakelists_line(dependency.symbol, 'VERSION', version)
end
update_cmakelists(dependency, archive, version)
end
function M.head(dependency_name)
local dependency = assert(get_dependency(dependency_name))
verify_cmakelists_committed()
local commit_sha = get_gh_commit_sha(dependency.repo, 'HEAD')
local archive = get_archive_info(dependency.repo, commit_sha)
if dependency_name == 'Luv' then
warn_luv_symbol()
end
update_cmakelists(dependency, archive, 'HEAD - ' .. short_commit(commit_sha))
end
function M.create_branch(dep)
explicit_create_branch(dep)
end
function M.submit_pr()
require_executable('git')
verify_branch('deps')
local nvim_remote = find_git_remote(nil)
local relevant_commit = assert(run_die({
print('Updating ' .. name .. ' to ' .. archive.url .. '\n')
update_deps_file(symbol, 'URL', archive.url:gsub('/', '\\/'))
update_deps_file(symbol, 'SHA256', archive.sha)
run_die({
'git',
'log',
'--grep=' .. commit_prefix,
'--reverse',
"--format='%s'",
nvim_remote .. '/master..HEAD',
'-1',
}, 'Failed to fetch commits'))
local pr_title
local pr_body
if relevant_commit == '' then
pr_title = commit_prefix .. 'bump some dependencies'
pr_body = 'bump some dependencies'
else
relevant_commit = relevant_commit:gsub("'", '')
pr_title = relevant_commit
pr_body = relevant_commit:gsub(commit_prefix:gsub('%(', '%%('):gsub('%)', '%%)'), '')
end
pr_body = pr_body .. '\n\n(add explanations if needed)'
p(pr_title .. '\n' .. pr_body .. '\n')
create_pr(pr_title, pr_body)
'commit',
deps_file,
'-m',
commit_prefix .. 'bump ' .. name .. ' to ' .. comment,
}, 'git failed to commit')
end
local function usage()
local this_script = _G.arg[0]:match('[^/]*.lua$')
print(([=[
local this_script = tostring(vim.fs.basename(_G.arg[0]))
local script_exe = './' .. this_script
local help = ([=[
Bump Nvim dependencies
Usage: nvim -l %s [options]
Bump to HEAD, tagged version, commit, or branch:
nvim -l %s --dep Luv --head
nvim -l %s --dep Luv --version 1.43.0-0
nvim -l %s --dep Luv --commit abc123
nvim -l %s --dep Luv --branch
Create a PR:
nvim -l %s --pr
Usage: %s [options]
Bump to HEAD, tagged version or commit:
%s luv --head
%s luv --ref 1.43.0-0
%s luv --ref abc123
Options:
-h show this message and exit.
--pr submit pr for bumping deps.
--branch <dep> create a branch bump-<dep> from current branch.
--dep <dependency> bump to a specific release or tag.
-h, --help show this message and exit.
--list list all dependencies
Dependency Options:
--version <tag> bump to a specific release or tag.
--commit <hash> bump to a specific commit.
--HEAD bump to a current head.
<dependency> is one of:
"LuaJIT", "libuv", "Luv", "tree-sitter"
]=]):format(this_script, this_script, this_script, this_script, this_script, this_script))
--ref <ref> bump to a specific commit or tag.
--head bump to a current head.
]=]):format(script_exe, script_exe, script_exe, script_exe)
print(help)
end
local function parseargs()
local args = {}
for i = 1, #_G.arg do
if _G.arg[i] == '-h' then
args.h = true
elseif _G.arg[i] == '--pr' then
args.pr = true
elseif _G.arg[i] == '--branch' then
args.branch = _G.arg[i + 1]
elseif _G.arg[i] == '--dep' then
args.dep = _G.arg[i + 1]
elseif _G.arg[i] == '--version' then
args.version = _G.arg[i + 1]
elseif _G.arg[i] == '--commit' then
args.commit = _G.arg[i + 1]
elseif _G.arg[i] == '--head' then
args.head = true
end
local function list_deps()
local l = 'Dependencies:\n'
for k in vim.spairs(dependency_table) do
l = string.format('%s\n%s%s', l, string.rep(' ', 2), k)
end
return args
print(l)
end
local is_main = _G.arg[0]:match('bump_deps.lua')
do
local args = {}
local i = 1
while i <= #_G.arg do
if _G.arg[i] == '-h' or _G.arg[i] == '--help' then
args.h = true
elseif _G.arg[i] == '--list' then
args.list = true
elseif _G.arg[i] == '--ref' then
args.ref = _G.arg[i + 1]
i = i + 1
elseif _G.arg[i] == '--head' then
args.ref = 'HEAD'
elseif vim.startswith(_G.arg[i], '--') then
die(string.format('Invalid argument %s\n', _G.arg[i]))
else
args.dep = _G.arg[i]
end
i = i + 1
end
if is_main then
local args = parseargs()
if args.h then
usage()
elseif args.pr then
M.submit_pr()
elseif args.head then
M.head(args.dep)
elseif args.branch then
M.create_branch(args.dep)
elseif args.version then
M.version(args.dep, args.version)
elseif args.commit then
M.commit(args.dep, args.commit)
elseif args.pr then
M.submit_pr()
elseif args.list then
list_deps()
elseif args.ref then
ref(args.dep, args.ref)
else
print('missing required arg\n')
os.exit(1)
die('missing required arg\n')
end
else
return M
end