IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

lint: bump_deps.lua

Browse Source
This commit is contained in:
Justin M. Keyes 2023-01-05 18:15:49 +01:00
parent 1c6be5e5e6
commit b741788a3a
1 changed files with 246 additions and 215 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

461
scripts/bump_deps.lua
View File

@ -17,19 +17,19 @@
local M = {} local M = {}
local _trace = false local _trace = false
local required_branch_prefix = "bump-" local required_branch_prefix = 'bump-'
local commit_prefix = "build(deps): " local commit_prefix = 'build(deps): '
-- Print message -- Print message
local function p(s) local function p(s)
vim.cmd("set verbose=1") vim.cmd('set verbose=1')
vim.api.nvim_echo({ { s, "" } }, false, {}) vim.api.nvim_echo({ { s, '' } }, false, {})
vim.cmd("set verbose=0") vim.cmd('set verbose=0')
end end
local function die() local function die()
p("") p('')
vim.cmd("cquit 1") vim.cmd('cquit 1')
end end
-- Executes and returns the output of `cmd`, or nil on failure. -- Executes and returns the output of `cmd`, or nil on failure.
@ -37,307 +37,338 @@ end
-- --
-- Prints `cmd` if `trace` is enabled. -- Prints `cmd` if `trace` is enabled.
local function _run(cmd, die_on_fail, die_msg) local function _run(cmd, die_on_fail, die_msg)
if _trace then if _trace then
p("run: " .. vim.inspect(cmd)) p('run: ' .. vim.inspect(cmd))
end end
local rv = vim.trim(vim.fn.system(cmd)) or "" local rv = vim.trim(vim.fn.system(cmd)) or ''
if vim.v.shell_error ~= 0 then if vim.v.shell_error ~= 0 then
if die_on_fail then if die_on_fail then
if _trace then if _trace then
p(rv) p(rv)
end end
p(die_msg) p(die_msg)
die() die()
end end
return nil return nil
end end
return rv return rv
end end
-- Run a command, return nil on failure -- Run a command, return nil on failure
local function run(cmd) local function run(cmd)
return _run(cmd, false, "") return _run(cmd, false, '')
end end
-- Run a command, die on failure with err_msg -- Run a command, die on failure with err_msg
local function run_die(cmd, err_msg) local function run_die(cmd, err_msg)
return _run(cmd, true, err_msg) return _run(cmd, true, err_msg)
end end
local function require_executable(cmd) local function require_executable(cmd)
local cmd_path = run_die({ "command", "-v", cmd }, cmd .. " not found!") local cmd_path = run_die({ 'command', '-v', cmd }, cmd .. ' not found!')
run_die({ "test", "-x", cmd_path }, cmd .. " is not executable") run_die({ 'test', '-x', cmd_path }, cmd .. ' is not executable')
end end
local function rm_file_if_present(path_to_file) local function rm_file_if_present(path_to_file)
run({ "rm", "-f", path_to_file }) run({ 'rm', '-f', path_to_file })
end end
local nvim_src_dir = vim.fn.getcwd() local nvim_src_dir = vim.fn.getcwd()
local temp_dir = nvim_src_dir .. "/tmp" local temp_dir = nvim_src_dir .. '/tmp'
run({ "mkdir", "-p", temp_dir }) run({ 'mkdir', '-p', temp_dir })
local function get_dependency(dependency_name) local function get_dependency(dependency_name)
local dependency_table = { local dependency_table = {
["LuaJIT"] = { ['LuaJIT'] = {
repo = "LuaJIT/LuaJIT", repo = 'LuaJIT/LuaJIT',
symbol = "LUAJIT", symbol = 'LUAJIT',
}, },
["libuv"] = { ['libuv'] = {
repo = "libuv/libuv", repo = 'libuv/libuv',
symbol = "LIBUV", symbol = 'LIBUV',
}, },
["Luv"] = { ['Luv'] = {
repo = "luvit/luv", repo = 'luvit/luv',
symbol = "LUV", symbol = 'LUV',
}, },
["tree-sitter"] = { ['tree-sitter'] = {
repo = "tree-sitter/tree-sitter", repo = 'tree-sitter/tree-sitter',
symbol = "TREESITTER", symbol = 'TREESITTER',
}, },
} }
local dependency = dependency_table[dependency_name] local dependency = dependency_table[dependency_name]
if dependency == nil then if dependency == nil then
p("Not a dependency: " .. dependency_name) p('Not a dependency: ' .. dependency_name)
die() die()
end end
dependency.name = dependency_name dependency.name = dependency_name
return dependency return dependency
end end
local function get_gh_commit_sha(repo, ref) local function get_gh_commit_sha(repo, ref)
require_executable("gh") require_executable('gh')
local sha = run_die( local sha = run_die(
{ "gh", "api", "repos/" .. repo .. "/commits/" .. ref, "--jq", ".sha" }, { 'gh', 'api', 'repos/' .. repo .. '/commits/' .. ref, '--jq', '.sha' },
"Failed to get commit hash from GitHub. Not a valid ref?" 'Failed to get commit hash from GitHub. Not a valid ref?'
) )
return sha return sha
end end
local function get_archive_info(repo, ref) local function get_archive_info(repo, ref)
require_executable("curl") require_executable('curl')
local archive_name = ref .. ".tar.gz" local archive_name = ref .. '.tar.gz'
local archive_path = temp_dir .. "/" .. archive_name local archive_path = temp_dir .. '/' .. archive_name
local archive_url = "https://github.com/" .. repo .. "/archive/" .. archive_name local archive_url = 'https://github.com/' .. repo .. '/archive/' .. archive_name
rm_file_if_present(archive_path) rm_file_if_present(archive_path)
run_die({ "curl", "-sL", archive_url, "-o", archive_path }, "Failed to download archive from GitHub") run_die(
{ 'curl', '-sL', archive_url, '-o', archive_path },
'Failed to download archive from GitHub'
)
local archive_sha = run({ "sha256sum", archive_path }):gmatch("%w+")() local archive_sha = run({ 'sha256sum', archive_path }):gmatch('%w+')()
return { url = archive_url, sha = archive_sha } return { url = archive_url, sha = archive_sha }
end end
local function write_cmakelists_line(symbol, kind, value) local function write_cmakelists_line(symbol, kind, value)
require_executable("sed") require_executable('sed')
local cmakelists_path = nvim_src_dir .. "/" .. "cmake.deps/CMakeLists.txt" local cmakelists_path = nvim_src_dir .. '/' .. 'cmake.deps/CMakeLists.txt'
run_die({ run_die({
"sed", 'sed',
"-i", '-i',
"-e", '-e',
"s/set(" .. symbol .. "_" .. kind .. ".*$" .. "/set(" .. symbol .. "_" .. kind .. " " .. value .. ")" .. "/", 's/set('
cmakelists_path, .. symbol
}, "Failed to write " .. cmakelists_path) .. '_'
.. kind
.. '.*$'
.. '/set('
.. symbol
.. '_'
.. kind
.. ' '
.. value
.. ')'
.. '/',
cmakelists_path,
}, 'Failed to write ' .. cmakelists_path)
end end
local function explicit_create_branch(dep) local function explicit_create_branch(dep)
require_executable("git") require_executable('git')
local checked_out_branch = run({ "git", "rev-parse", "--abbrev-ref", "HEAD" }) local checked_out_branch = run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' })
if checked_out_branch ~= "master" then if checked_out_branch ~= 'master' then
p("Not on master!") p('Not on master!')
die() die()
end end
run_die({ "git", "checkout", "-b", "bump-" .. dep }, "git failed to create branch") run_die({ 'git', 'checkout', '-b', 'bump-' .. dep }, 'git failed to create branch')
end end
local function verify_branch(new_branch_suffix) local function verify_branch(new_branch_suffix)
require_executable("git") require_executable('git')
local checked_out_branch = run({ "git", "rev-parse", "--abbrev-ref", "HEAD" }) local checked_out_branch = run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' })
if not checked_out_branch:match("^" .. required_branch_prefix) then 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(
p("Checking out to bump-" .. new_branch_suffix) "Current branch '"
explicit_create_branch(new_branch_suffix) .. checked_out_branch
end .. "' 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 end
local function update_cmakelists(dependency, archive, comment) local function update_cmakelists(dependency, archive, comment)
require_executable("git") require_executable('git')
verify_branch(dependency.name) verify_branch(dependency.name)
local changed_file = nvim_src_dir .. "/" .. "cmake.deps/CMakeLists.txt" local changed_file = nvim_src_dir .. '/' .. 'cmake.deps/CMakeLists.txt'
p("Updating " .. dependency.name .. " to " .. archive.url .. "\n") p('Updating ' .. dependency.name .. ' to ' .. archive.url .. '\n')
write_cmakelists_line(dependency.symbol, "URL", archive.url:gsub("/", "\\/")) write_cmakelists_line(dependency.symbol, 'URL', archive.url:gsub('/', '\\/'))
write_cmakelists_line(dependency.symbol, "SHA256", archive.sha) write_cmakelists_line(dependency.symbol, 'SHA256', archive.sha)
run_die( run_die(
{ "git", "commit", changed_file, "-m", commit_prefix .. "bump " .. dependency.name .. " to " .. comment }, {
"git failed to commit" 'git',
) 'commit',
changed_file,
'-m',
commit_prefix .. 'bump ' .. dependency.name .. ' to ' .. comment,
},
'git failed to commit'
)
end end
local function verify_cmakelists_committed() local function verify_cmakelists_committed()
require_executable("git") require_executable('git')
local cmakelists_path = nvim_src_dir .. "/" .. "cmake.deps/CMakeLists.txt" local cmakelists_path = nvim_src_dir .. '/' .. 'cmake.deps/CMakeLists.txt'
run_die({ "git", "diff", "--quiet", "HEAD", "--", cmakelists_path }, cmakelists_path .. " has uncommitted changes") run_die(
{ 'git', 'diff', '--quiet', 'HEAD', '--', cmakelists_path },
cmakelists_path .. ' has uncommitted changes'
)
end end
local function warn_luv_symbol() local function warn_luv_symbol()
p("warning: " .. get_dependency("Luv").symbol .. "_VERSION will not be updated") p('warning: ' .. get_dependency('Luv').symbol .. '_VERSION will not be updated')
end end
-- return first 9 chars of commit -- return first 9 chars of commit
local function short_commit(commit) local function short_commit(commit)
return string.sub(commit, 1, 9) return string.sub(commit, 1, 9)
end end
-- TODO: remove hardcoded fork -- TODO: remove hardcoded fork
local function gh_pr(pr_title, pr_body) local function gh_pr(pr_title, pr_body)
require_executable("gh") require_executable('gh')
local pr_url = run_die({ local pr_url = run_die({
"gh", 'gh',
"pr", 'pr',
"create", 'create',
"--title", '--title',
pr_title, pr_title,
"--body", '--body',
pr_body, pr_body,
}, "Failed to create PR") }, 'Failed to create PR')
return pr_url return pr_url
end end
local function find_git_remote(fork) local function find_git_remote(fork)
require_executable("git") require_executable('git')
local remotes = run({ "git", "remote", "-v" }) local remotes = run({ 'git', 'remote', '-v' })
local git_remote = "" local git_remote = ''
for remote in remotes:gmatch("[^\r\n]+") do for remote in remotes:gmatch('[^\r\n]+') do
local words = {} local words = {}
for word in remote:gmatch("%w+") do for word in remote:gmatch('%w+') do
table.insert(words, word) table.insert(words, word)
end end
local match = words[1]:match("/github.com[:/]neovim/neovim/") local match = words[1]:match('/github.com[:/]neovim/neovim/')
if fork == "fork" then if fork == 'fork' then
match = not match match = not match
end end
if match and words[3] == "(fetch)" then if match and words[3] == '(fetch)' then
git_remote = words[0] git_remote = words[0]
break break
end end
end end
if git_remote == "" then if git_remote == '' then
git_remote = "origin" git_remote = 'origin'
end end
return git_remote return git_remote
end end
local function create_pr(pr_title, pr_body) local function create_pr(pr_title, pr_body)
require_executable("git") require_executable('git')
local push_first = true local push_first = true
local checked_out_branch = run({ "git", "rev-parse", "--abbrev-ref", "HEAD" }) local checked_out_branch = run({ 'git', 'rev-parse', '--abbrev-ref', 'HEAD' })
if push_first then if push_first then
local push_remote = run({ "git", "config", "--get", "branch." .. checked_out_branch .. ".pushRemote" }) local push_remote =
if push_remote == nil then run({ 'git', 'config', '--get', 'branch.' .. checked_out_branch .. '.pushRemote' })
push_remote = run({ "git", "config", "--get", "remote.pushDefault" }) if push_remote == nil then
if push_remote == nil then push_remote = run({ 'git', 'config', '--get', 'remote.pushDefault' })
push_remote = run({ "git", "config", "--get", "branch." .. checked_out_branch .. ".remote" }) if push_remote == nil then
if push_remote == nil or push_remote == find_git_remote(nil) then push_remote =
push_remote = find_git_remote("fork") run({ 'git', 'config', '--get', 'branch.' .. checked_out_branch .. '.remote' })
end if push_remote == nil or push_remote == find_git_remote(nil) then
end push_remote = find_git_remote('fork')
end end
end
end
p("Pushing to " .. push_remote .. "/" .. checked_out_branch) p('Pushing to ' .. push_remote .. '/' .. checked_out_branch)
run_die({ "git", "push", push_remote, checked_out_branch }, "Git failed to push") run_die({ 'git', 'push', push_remote, checked_out_branch }, 'Git failed to push')
end end
local pr_url = gh_pr(pr_title, pr_body) local pr_url = gh_pr(pr_title, pr_body)
p("\nCreated PR: " .. pr_url .. "\n") p('\nCreated PR: ' .. pr_url .. '\n')
end end
function M.commit(dependency_name, commit) function M.commit(dependency_name, commit)
local dependency = get_dependency(dependency_name) local dependency = get_dependency(dependency_name)
verify_cmakelists_committed() verify_cmakelists_committed()
local commit_sha = get_gh_commit_sha(dependency.repo, commit) local commit_sha = get_gh_commit_sha(dependency.repo, commit)
if commit_sha ~= commit then if commit_sha ~= commit then
p("Not a commit: " .. commit .. ". Did you mean version?") p('Not a commit: ' .. commit .. '. Did you mean version?')
die() die()
end end
local archive = get_archive_info(dependency.repo, commit) local archive = get_archive_info(dependency.repo, commit)
if dependency_name == "Luv" then if dependency_name == 'Luv' then
warn_luv_symbol() warn_luv_symbol()
end end
update_cmakelists(dependency, archive, short_commit(commit)) update_cmakelists(dependency, archive, short_commit(commit))
end end
function M.version(dependency_name, version) function M.version(dependency_name, version)
local dependency = get_dependency(dependency_name) local dependency = get_dependency(dependency_name)
verify_cmakelists_committed() verify_cmakelists_committed()
local commit_sha = get_gh_commit_sha(dependency.repo, version) local commit_sha = get_gh_commit_sha(dependency.repo, version)
if commit_sha == version then if commit_sha == version then
p("Not a version: " .. version .. ". Did you mean commit?") p('Not a version: ' .. version .. '. Did you mean commit?')
die() die()
end end
local archive = get_archive_info(dependency.repo, version) local archive = get_archive_info(dependency.repo, version)
if dependency_name == "Luv" then if dependency_name == 'Luv' then
write_cmakelists_line(dependency.symbol, "VERSION", version) write_cmakelists_line(dependency.symbol, 'VERSION', version)
end end
update_cmakelists(dependency, archive, version) update_cmakelists(dependency, archive, version)
end end
function M.head(dependency_name) function M.head(dependency_name)
local dependency = get_dependency(dependency_name) local dependency = get_dependency(dependency_name)
verify_cmakelists_committed() verify_cmakelists_committed()
local commit_sha = get_gh_commit_sha(dependency.repo, "HEAD") local commit_sha = get_gh_commit_sha(dependency.repo, 'HEAD')
local archive = get_archive_info(dependency.repo, commit_sha) local archive = get_archive_info(dependency.repo, commit_sha)
if dependency_name == "Luv" then if dependency_name == 'Luv' then
warn_luv_symbol() warn_luv_symbol()
end end
update_cmakelists(dependency, archive, "HEAD - " .. short_commit(commit_sha)) update_cmakelists(dependency, archive, 'HEAD - ' .. short_commit(commit_sha))
end end
function M.create_branch(dep) function M.create_branch(dep)
explicit_create_branch(dep) explicit_create_branch(dep)
end end
function M.submit_pr() function M.submit_pr()
require_executable("git") require_executable('git')
verify_branch("deps") verify_branch('deps')
local nvim_remote = find_git_remote(nil) local nvim_remote = find_git_remote(nil)
local relevant_commit = run_die({ local relevant_commit = run_die({
"git", 'git',
"log", 'log',
"--grep=" .. commit_prefix, '--grep=' .. commit_prefix,
"--reverse", '--reverse',
"--format='%s'", "--format='%s'",
nvim_remote .. "/master..HEAD", nvim_remote .. '/master..HEAD',
"-1", '-1',
}, "Failed to fetch commits") }, 'Failed to fetch commits')
local pr_title local pr_title
local pr_body local pr_body
if relevant_commit == "" then if relevant_commit == '' then
pr_title = commit_prefix .. "bump some dependencies" pr_title = commit_prefix .. 'bump some dependencies'
pr_body = "bump some dependencies" pr_body = 'bump some dependencies'
else else
relevant_commit = relevant_commit:gsub("'", "") relevant_commit = relevant_commit:gsub("'", '')
pr_title = relevant_commit pr_title = relevant_commit
pr_body = relevant_commit:gsub(commit_prefix:gsub("%(", "%%("):gsub("%)", "%%)"), "") pr_body = relevant_commit:gsub(commit_prefix:gsub('%(', '%%('):gsub('%)', '%%)'), '')
end end
pr_body = pr_body .. "\n\n(add explanations if needed)" pr_body = pr_body .. '\n\n(add explanations if needed)'
p(pr_title .. "\n" .. pr_body .. "\n") p(pr_title .. '\n' .. pr_body .. '\n')
create_pr(pr_title, pr_body) create_pr(pr_title, pr_body)
end end
return M return M