[CLI] Limit changelog output to last 5 releases and add --show-all option

Author: egorikftp

README.md

@@ -341,6 +341,12 @@ Usage:
 <img src="assets/cli_valkyrie_changelog.png" width="550" />
 </div>
 
+Output example:
+
+<div align="center">
+<img src="assets/cli_valkyrie_changelog_output.png" width="550" />
+</div>
+
 ### Build CLI
 
 Run `./gradlew buildCLI` to build minified version of CLI tool. Artifact will be available in

assets/cli_valkyrie_changelog.png

@@ -1,5 +1,5 @@
 [versions]
-cli-version = "1.0.0"
+cli-version = "1.0.1"
 
 clikt = "5.0.3"
 

assets/cli_valkyrie_changelog_output.png

@@ -1,5 +1,10 @@
 # CLI Changelog
 
+## [1.0.1] - 2025-11-20
+
+- Limited changelog output to the last 5 releases
+- Added `--show-all` option to display full changelog
+
 ## [1.0.0] - 2025-11-17
 
 - Stabilize CLI tool

gradle/cli.versions.toml

@@ -3,14 +3,43 @@ package io.github.composegears.valkyrie.cli.command
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.core.Context
 import com.github.ajalt.mordant.markdown.Markdown
+import io.github.composegears.valkyrie.cli.ext.flagOption
 
 internal class ChangelogCommand : CliktCommand(name = "changelog") {
 
+    private val showAll by flagOption(
+        "--show-all",
+        help = "Show full release history",
+    )
+
     override fun run() {
-        echo(Markdown(loadResourceText("CHANGELOG.md"), showHtml = true))
+        val changelog = loadResourceText("CHANGELOG.md")
+
+        val markdownContent = when {
+            showAll -> changelog
+            else -> getLatestReleases(changelog)
+        }
+        echo(Markdown(markdown = markdownContent))
     }
 
     override fun help(context: Context): String = "Print CLI changelog"
+
+    private fun getLatestReleases(changelog: String, count: Int = 5): String {
+        val lines = changelog.lines()
+        val releaseIndices = lines.indices.filter { index ->
+            lines[index].trimStart().startsWith("## [")
+        }
+
+        if (releaseIndices.size <= count) {
+            return changelog
+        }
+
+        val endIndex = releaseIndices[count]
+        val limitedLines = lines.subList(0, endIndex)
+        val result = limitedLines.joinToString("\n")
+
+        return "$result\n\n---\n\n*Showing $count latest releases. Use \"--show-all\" to see the full changelog.*"
+    }
 }
 
 private fun Any.loadResourceText(name: String): String {

tools/cli/CHANGELOG.md

@@ -2,6 +2,7 @@ package io.github.composegears.valkyrie.cli.ext
 
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.parameters.options.default
+import com.github.ajalt.clikt.parameters.options.flag
 import com.github.ajalt.clikt.parameters.options.option
 import com.github.ajalt.clikt.parameters.options.required
 import com.github.ajalt.clikt.parameters.types.boolean
@@ -40,3 +41,9 @@ internal fun CliktCommand.intOption(
     help: String,
     default: Int,
 ) = option(names = names, help = help).int().default(default)
+
+internal fun CliktCommand.flagOption(
+    vararg names: String,
+    help: String,
+    default: Boolean = false,
+) = option(names = names, help = help).flag(default = default)

tools/cli/src/main/kotlin/io/github/composegears/valkyrie/cli/command/ChangelogCommand.kt

@@ -2,17 +2,46 @@ package io.github.composegears.valkyrie.cli.command
 
 import assertk.assertThat
 import assertk.assertions.contains
+import assertk.assertions.doesNotContain
+import assertk.assertions.isLessThan
 import assertk.assertions.isNotEmpty
 import com.github.ajalt.clikt.testing.test
 import kotlin.test.Test
 
 class ChangelogCommandTest {
 
     @Test
-    fun `run should print CHANGELOG content`() {
+    fun `should print 5 latest releases`() {
         val result = ChangelogCommand().test()
 
         assertThat(result.output).contains("CLI Changelog")
+        assertThat(result.output).contains("Showing 5 latest releases")
+        assertThat(result.output).contains("Use \"--show-all\" to see the full changelog")
+    }
+
+    @Test
+    fun `should print full changelog with show-all option`() {
+        val result = ChangelogCommand().test("--show-all")
+
+        assertThat(result.output).contains("CLI Changelog")
+        assertThat(result.output).doesNotContain("Showing 5 latest releases")
+        // Should contain all releases including the initial one
+        assertThat(result.output).contains("Initial release of Valkyrie CLI tool")
+    }
+
+    @Test
+    fun `limited changelog should be shorter than full changelog`() {
+        val limitedResult = ChangelogCommand().test()
+        val fullResult = ChangelogCommand().test("--show-all")
+
+        // Limited version should have the "Showing X latest releases" message
+        assertThat(limitedResult.output).contains("Showing 5 latest releases")
+
+        // Full version should not have this message
+        assertThat(fullResult.output).doesNotContain("Showing 5 latest releases")
+
+        // Limited version should be shorter than full version
+        assertThat(limitedResult.output.length).isLessThan(fullResult.output.length)
     }
 
     @Test
@@ -21,5 +50,6 @@ class ChangelogCommandTest {
 
         assertThat(result.output).isNotEmpty()
         assertThat(result.output).contains("Print CLI changelog")
+        assertThat(result.output).contains("--show-all")
     }
 }