[JENKINS-40023] JGit changelog max limit not working well with merge commits

git-client version 2.1.0

Jgit changelog does not work well when setting max revisions limit, if the revisions containt merge commits.

That is because RevWalker will only return the number of revision as set by limitations, but ChangelogCommand default behaviour is to skip merge commits. Resulting in returning less commits then requested by the user.

This can be seen by the below test case (for GitApiTestCase class) where JGit returns empty changelog if the head commit is a merge commit, and max limit was set to 1. The test will pass if the max limit is increased to 2.

    public void test_changelog_with_merge_commit_and_max_log_history() throws Exception {

w.init();

w.commitEmpty("init");


// First commit to branch1

w.git.branch("branch1");

w.git.checkout("branch1");

w.touch("file1", "content1");

w.git.add("file1");

w.git.commit("commit1");

String commitSha1 = w.git.revParse("HEAD").name();

// Merge branch1 into master

w.git.checkout("master");

String mergeMessage = "Merge message to be tested.";

w.git.merge().setMessage(mergeMessage).setGitPluginFastForwardMode(MergeCommand.GitPluginFastForwardMode.NO_FF).setRevisionToMerge(w.git.getHeadRev(w.repoPath(), "branch1")).execute();

StringWriter writer = new StringWriter();

w.git.changelog().max(1).to(writer).execute(); // Changing max limit to 2 will pass the test

assertThat(writer.toString(),not(isEmptyString()));

    }

---
Originally reported by tzafrir11, imported from: JGit changelog max limit not working well with merge commits

• status: Open
  
• priority: Minor
  
• component(s): git-client-plugin
  
• resolution: Unresolved
  
• votes: 0
  
• watchers: 2
  
• imported: 20251211-071809
  

Raw content of original issue

git-client version 2.1.0

Jgit changelog does not work well when setting max revisions limit, if the revisions containt merge commits.

That is because RevWalker will only return the number of revision as set by limitations, but ChangelogCommand default behaviour is to skip merge commits. Resulting in returning less commits then requested by the user.

This can be seen by the below test case (for GitApiTestCase class) where JGit returns empty changelog if the head commit is a merge commit, and max limit was set to 1. The test will pass if the max limit is increased to 2.




    public void test_changelog_with_merge_commit_and_max_log_history() throws Exception {

        w.init();

        w.commitEmpty("init");


        // First commit to branch1

        w.git.branch("branch1");

        w.git.checkout("branch1");

        w.touch("file1", "content1");

        w.git.add("file1");

        w.git.commit("commit1");

        String commitSha1 = w.git.revParse("HEAD").name();

        // Merge branch1 into master

        w.git.checkout("master");

        String mergeMessage = "Merge message to be tested.";

        w.git.merge().setMessage(mergeMessage).setGitPluginFastForwardMode(MergeCommand.GitPluginFastForwardMode.NO_FF).setRevisionToMerge(w.git.getHeadRev(w.repoPath(), "branch1")).execute();

        StringWriter writer = new StringWriter();

        w.git.changelog().max(1).to(writer).execute(); // Changing max limit to 2 will pass the test

        assertThat(writer.toString(),not(isEmptyString()));

    }