tarantool / tarantool/tarantool

Add CI workflow for checking submodules

Open
#6,984 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

infrastructure
Dominant language
Lua
Stars
3.7k
Forks
419
Avg merge
1d 23h
Merged PRs (30d)
88

Description

With private forks and multiple submodules, it's quite easy to slip up and merge a commit that updates a submodule to a commit from someone's private fork. We need a workflow that checks that all submodules point to commits from original repositories, not from forks.

Note: There's a similar ticket for checkpatch https://github.com/tarantool/checkpatch/issues/9. However, checking submodules should probably be done in a separate workflow so that we can differentiate a malformed patch case from the situation when the submodule is intentionally set to a private fork, because the submodule commit hasn't been merged yet (i.e. it's okay to review the pull request, but it shouldn't be merged until the submodule repository is updated; this is especially actual for the enterprise repository, where submodule updates happen regularly). It still makes sense to require a separate tag in the commit message, indicating that a submodule update is intentional though.

Note: We have a script that implements a similar check, but it doesn't check all submodules so it should be fixed before it can be used in the new workflow.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with tools/check_push_master.sh and compare its submodule check with the separate checkpatch issue linked in the description. Define the workflow entry point and the intentional-update tag from the issue requirements; done means every submodule is checked against its original repository and intentional private-fork updates are distinguishable from malformed updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions, shell
Domain
ci-cd, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.