Output

Author: srtfisher

README.md

@@ -5,14 +5,41 @@ A GitHub Action that parses [Keep a Changelog](https://keepachangelog.com/) form
 ## Features
 
 - 📝 Parses Keep a Changelog format (like [Mantle Framework](https://github.com/alleyinteractive/mantle-framework))
-- 🎯 Extract specific versions or the latest release
+- 🎯 Extract all versions or a specific version
 - 📦 Returns structured data with sections (Added, Changed, Fixed, etc.)
+- 🔄 Supports mixed formats (with and without subsections)
 - ✅ Comprehensive Jest test suite
 - 🚀 Zero build step - pure JavaScript
 
 ## Usage
 
-### Basic Example
+### Extract All Versions
+
+By default, the action returns all versions in the changelog:
+
+```yaml
+- name: Extract All Changelog Entries
+  id: changelog
+  uses: alleyinteractive/action-changelog-extractor@v1
+
+- name: Process All Versions
+  run: |
+    # Access the first (latest) version
+    echo '${{ fromJson(steps.changelog.outputs.result)[0].contents }}'
+```
+
+### Extract Specific Version
+
+```yaml
+- name: Extract v1.14.0 Changelog
+  id: changelog
+  uses: alleyinteractive/action-changelog-extractor@v1
+  with:
+    changelog-path: 'CHANGELOG.md'
+    version: '1.14.0'  # or 'v1.14.0'
+```
+
+### Create Release from Latest Version
 
 ```yaml
 name: Release
@@ -30,8 +57,6 @@ jobs:
       - name: Extract Changelog
         id: changelog
         uses: alleyinteractive/action-changelog-extractor@v1
-        with:
-          version: 'latest'
 
       - name: Create Release
         uses: actions/create-release@v1
@@ -40,42 +65,16 @@ jobs:
         with:
           tag_name: ${{ github.ref }}
           release_name: Release ${{ github.ref }}
+          # Use the first (latest) version from the changelog
           body: ${{ fromJson(steps.changelog.outputs.result)[0].contents }}
 ```
 
-### Extract Specific Version
-
-```yaml
-- name: Extract v1.14.0 Changelog
-  id: changelog
-  uses: alleyinteractive/action-changelog-extractor@v1
-  with:
-    changelog-path: 'CHANGELOG.md'
-    version: '1.14.0'  # or 'v1.14.0'
-```
-
-### Use Individual Sections
-
-```yaml
-- name: Extract Changelog
-  id: changelog
-  uses: alleyinteractive/action-changelog-extractor@v1
-
-- name: Process Sections
-  run: |
-    echo "Added features:"
-    echo '${{ fromJson(steps.changelog.outputs.result)[0].sections.added }}'
-
-    echo "Bug fixes:"
-    echo '${{ fromJson(steps.changelog.outputs.result)[0].sections.fixed }}'
-```
-
 ## Inputs
 
 | Input | Description | Required | Default |
 |-------|-------------|----------|---------|
 | `changelog-path` | Path to the changelog file | No | `CHANGELOG.md` |
-| `version` | Version to extract (`latest`, `1.14.0`, or `v1.14.0`) | No | `latest` |
+| `version` | Specific version to extract (e.g., `1.14.0` or `v1.14.0`). Leave empty to return all versions. | No | _(returns all)_ |
 
 ## Outputs
 

__tests__/parser.test.js

@@ -78,10 +78,10 @@ describe('parseChangelog', () => {
       expect(results[5].name).toBe('1.13.0');
     });
 
-    test('extracts latest version', () => {
-      const results = parseChangelog(sampleChangelog, 'latest');
+    test('extracts all versions by default', () => {
+      const results = parseChangelog(sampleChangelog);
 
-      expect(results).toHaveLength(1);
+      expect(results).toHaveLength(6);
       expect(results[0].name).toBe('1.14.0');
     });
 
@@ -232,28 +232,28 @@ describe('parseChangelog', () => {
 
   describe('output structure', () => {
     test('each result has required properties', () => {
-      const results = parseChangelog(sampleChangelog, 'latest');
+      const results = parseChangelog(sampleChangelog, '1.14.0');
 
       expect(results[0]).toHaveProperty('name');
       expect(results[0]).toHaveProperty('sections');
       expect(results[0]).toHaveProperty('contents');
     });
 
     test('name is a string', () => {
-      const results = parseChangelog(sampleChangelog, 'latest');
+      const results = parseChangelog(sampleChangelog, '1.14.0');
 
       expect(typeof results[0].name).toBe('string');
     });
 
     test('sections is an object', () => {
-      const results = parseChangelog(sampleChangelog, 'latest');
+      const results = parseChangelog(sampleChangelog, '1.14.0');
 
       expect(typeof results[0].sections).toBe('object');
       expect(Array.isArray(results[0].sections)).toBe(false);
     });
 
     test('contents is a string', () => {
-      const results = parseChangelog(sampleChangelog, 'latest');
+      const results = parseChangelog(sampleChangelog, '1.14.0');
 
       expect(typeof results[0].contents).toBe('string');
     });

action.yml

@@ -12,9 +12,8 @@ inputs:
     required: false
     default: 'CHANGELOG.md'
   version:
-    description: 'Version to extract (e.g., "1.14.0", "v1.14.0", or "latest")'
+    description: 'Specific version to extract (e.g., "1.14.0" or "v1.14.0"). Leave empty to return all versions.'
     required: false
-    default: 'latest'
 
 outputs:
   result:

cli.js

@@ -11,19 +11,24 @@ const { parseChangelog } = require('./src/parser');
 
 function printUsage() {
   console.log(`
-Usage: node cli.js [changelog-file] [version]
+Usage: node cli.js [options] [changelog-file] [version]
+
+Options:
+  -l, --list     List the count of versions found and exit
+  -h, --help     Show this help message
 
 Arguments:
   changelog-file  Path to changelog file (default: CHANGELOG.md)
-  version        Version to extract (default: latest)
-                 Can be: "latest", "1.14.0", "v1.14.0", or null for all versions
+  version        Specific version to extract (e.g., "1.14.0" or "v1.14.0")
+                 Leave empty to return all versions (default: all versions)
 
 Examples:
-  node cli.js                           # Parse CHANGELOG.md, extract latest
-  node cli.js CHANGELOG.md latest       # Same as above
+  node cli.js                           # Parse CHANGELOG.md, extract all versions
+  node cli.js -l                        # Count versions in CHANGELOG.md
+  node cli.js CHANGELOG.md              # Same as above
   node cli.js CHANGELOG.md 1.14.0       # Extract specific version
-  node cli.js CHANGELOG.md all          # Extract all versions
-  node cli.js /tmp/test-changelog.md    # Parse specific file
+  node cli.js /tmp/test-changelog.md    # Parse specific file, all versions
+  node cli.js -l /tmp/test-changelog.md # Count versions in specific file
 `);
 }
 
@@ -35,9 +40,12 @@ if (args.includes('--help') || args.includes('-h')) {
   process.exit(0);
 }
 
-const changelogFile = args[0] || 'CHANGELOG.md';
-const versionArg = args[1] || 'latest';
-const version = versionArg === 'all' ? null : versionArg;
+const listMode = args.includes('-l') || args.includes('--list');
+const filteredArgs = args.filter(arg => arg !== '-l' && arg !== '--list');
+
+const changelogFile = filteredArgs[0] || 'CHANGELOG.md';
+const versionArg = filteredArgs[1] || null;
+const version = versionArg;
 
 // Read changelog file
 const changelogPath = path.resolve(process.cwd(), changelogFile);
@@ -50,14 +58,20 @@ if (!fs.existsSync(changelogPath)) {
 
 const changelogContent = fs.readFileSync(changelogPath, 'utf8');
 
-// Parse changelog
-console.log(`📖 Parsing: ${changelogPath}`);
-console.log(`🎯 Version: ${versionArg}`);
-console.log('');
-
 try {
   const results = parseChangelog(changelogContent, version);
 
+  // List mode: just display count and exit
+  if (listMode) {
+    console.log(`${results.length}`);
+    process.exit(0);
+  }
+
+  // Parse changelog
+  console.log(`📖 Parsing: ${changelogPath}`);
+  console.log(`🎯 Version: ${versionArg || 'all versions'}`);
+  console.log('');
+
   if (results.length === 0) {
     console.log('⚠️  No changelog entries found');
     process.exit(0);

src/index.js

@@ -9,7 +9,10 @@ async function run(core) {
   try {
     // Get inputs
     const changelogPath = core.getInput('changelog-path') || 'CHANGELOG.md';
-    const version = core.getInput('version') || 'latest';
+    const versionInput = core.getInput('version');
+
+    // Only pass version if explicitly specified, otherwise return all versions
+    const version = versionInput || null;
 
     // Read changelog file
     const fullPath = path.resolve(process.cwd(), changelogPath);
@@ -24,7 +27,7 @@ async function run(core) {
     const results = parseChangelog(changelogContent, version);
 
     if (results.length === 0) {
-      core.warning(`No changelog entries found${version !== 'latest' ? ` for version ${version}` : ''}`);
+      core.warning(`No changelog entries found${version ? ` for version ${version}` : ''}`);
     }
 
     // Set output as JSON string

src/parser.js

@@ -2,10 +2,10 @@
  * Parse a Keep a Changelog formatted changelog file.
  *
  * @param {string} changelogContent - The raw markdown content of the changelog
- * @param {string|null} version - Specific version to extract (e.g., "v1.14.0" or "1.14.0"), or "latest" for most recent
+ * @param {string|null} version - Specific version to extract (e.g., "v1.14.0" or "1.14.0"), or null/undefined for all versions
  * @returns {Array<{name: string, sections: Object, contents: string}>} Array of version objects
  */
-function parseChangelog(changelogContent, version = 'latest') {
+function parseChangelog(changelogContent, version = null) {
   const versions = [];
   const lines = changelogContent.split('\n');
 
@@ -145,18 +145,14 @@ function parseChangelog(changelogContent, version = 'latest') {
     ver.contents = contentParts.join('\n\n');
   }
 
-  // Filter by version if specified
-  if (version && version !== 'latest') {
+  // Filter by specific version if requested
+  if (version) {
     const normalizedVersion = version.replace(/^v/, ''); // Remove 'v' prefix if present
     const filtered = versions.filter(v => v.name === normalizedVersion);
     return filtered;
   }
 
-  // Return latest version if requested
-  if (version === 'latest' && versions.length > 0) {
-    return [versions[0]];
-  }
-
+  // Return all versions by default
   return versions;
 }