@alleyinteractive/changelog-extractor 0.0.1 → 0.3.0

package/README.md

@@ -1,17 +1,19 @@
 # Changelog Extractor
 
-Parse and extract structured information from [Keep a Changelog](https://keepachangelog.com/) formatted changelogs. Available as both a **GitHub Action** and a **CLI tool**.
+Parse and extract structured information from
+[Keep a Changelog](https://keepachangelog.com/) formatted changelogs. Available
+as both a **GitHub Action** and a **CLI tool**.
 
 ## Features
 
-- 📝 Parses Keep a Changelog format (like [Mantle Framework](https://github.com/alleyinteractive/mantle-framework))
-- 🎯 Extract all versions or a specific version
-- 📦 Returns structured data with sections (Added, Changed, Fixed, etc.)
-- 🔄 Supports mixed formats (with and without subsections)
-- ⚡ Available as CLI tool via npx
-- 🤖 Works as GitHub Action
-- ✅ Comprehensive Jest test suite
-- 🚀 Zero build step - pure JavaScript
+- Parses Keep a Changelog format (tested with
+  [Mantle Framework](https://github.com/alleyinteractive/mantle-framework) and
+  others)
+- Extract all versions or filter to a specific one
+- Returns structured data with sections (Added, Changed, Fixed, etc.)
+- Handles mixed formats, including versions without subsections
+- Available as a CLI tool via npx or as a GitHub Action
+- Written in plain JavaScript with no build step required
 
 ## Usage
 
@@ -42,7 +44,7 @@ By default, the action returns all versions in the changelog:
   uses: alleyinteractive/action-changelog-extractor@v1
   with:
     changelog-path: 'CHANGELOG.md'
-    version: '1.14.0'  # or 'v1.14.0'
+    version: '1.14.0' # or 'v1.14.0'
 ```
 
 ### Create Release from Latest Version
@@ -77,15 +79,15 @@ jobs:
 
 #### Action Inputs
 
-| Input | Description | Required | Default |
-|-------|-------------|----------|---------|
-| `changelog-path` | Path to the changelog file | No | `CHANGELOG.md` |
-| `version` | Specific version to extract (e.g., `1.14.0` or `v1.14.0`). Leave empty to return all versions. | No | _(returns all)_ |
+| Input            | Description                                                                                    | Required | Default         |
+| ---------------- | ---------------------------------------------------------------------------------------------- | -------- | --------------- |
+| `changelog-path` | Path to the changelog file                                                                     | No       | `CHANGELOG.md`  |
+| `version`        | Specific version to extract (e.g., `1.14.0` or `v1.14.0`). Leave empty to return all versions. | No       | _(returns all)_ |
 
 #### Action Outputs
 
-| Output | Description |
-|--------|-------------|
+| Output   | Description                                            |
+| -------- | ------------------------------------------------------ |
 | `result` | JSON string containing array of parsed version objects |
 
 #### Output Structure
@@ -107,9 +109,12 @@ The `result` output is a JSON string that can be parsed with `fromJson()`:
 ```
 
 **Properties:**
+
 - `name` - Version number without "v" prefix
-- `sections` - Object with lowercase keys (`added`, `changed`, `fixed`, `deprecated`, `removed`, `security`)
-- `contents` - Full markdown content for the version (all sections combined, without version header)
+- `sections` - Object with lowercase keys (`added`, `changed`, `fixed`,
+  `deprecated`, `removed`, `security`)
+- `contents` - Full markdown content for the version (all sections combined,
+  without version header)
 
 ### As a CLI Tool
 
@@ -138,7 +143,8 @@ changelog-extractor
 
 ## Supported Changelog Format
 
-This action parses changelogs following the [Keep a Changelog](https://keepachangelog.com/) format:
+This action parses changelogs following the
+[Keep a Changelog](https://keepachangelog.com/) format:
 
 ```markdown
 # Changelog
@@ -146,21 +152,26 @@ This action parses changelogs following the [Keep a Changelog](https://keepachan
 ## v1.14.0
 
 ### Added
+
 - New feature description
 
 ### Changed
+
 - Changes made
 
 ### Fixed
+
 - Bugs fixed
 
 ## v1.13.0 - 2024-08-15
 
 ### Added
+
 - Another feature
 ```
 
 **Supported section types:**
+
 - Added
 - Changed
 - Deprecated
@@ -188,18 +199,18 @@ Arguments:
 You can also use the parser directly in your Node.js code:
 
 ```javascript
-const { parseChangelog } = require('@alleyinteractive/changelog-extractor');
-const fs = require('fs');
+const { parseChangelog } = require('@alleyinteractive/changelog-extractor')
+const fs = require('fs')
 
-const changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
+const changelog = fs.readFileSync('CHANGELOG.md', 'utf8')
 
 // Get all versions
-const allVersions = parseChangelog(changelog);
+const allVersions = parseChangelog(changelog)
 
 // Get specific version
-const v1 = parseChangelog(changelog, '1.14.0');
+const v1 = parseChangelog(changelog, '1.14.0')
 
-console.log(JSON.stringify(allVersions, null, 2));
+console.log(JSON.stringify(allVersions, null, 2))
 ```
 
 ## Development
@@ -237,14 +248,19 @@ node cli.js -l
 node cli.js CHANGELOG.md 1.0.0
 ```
 
-## License
+## Changelog
 
-GPL-3.0 - see [LICENSE](LICENSE) for details.
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed
+recently.
 
-## Contributing
+## Credits
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+This project is actively maintained by
+[Alley Interactive](https://github.com/alleyinteractive).
 
-## Credits
+- [Sean Fisher](https://github.com/srtfisher)
+
+## License
 
-Maintained by [Alley Interactive](https://github.com/alleyinteractive).
+The GNU General Public License (GPL) license. Please see [License File](LICENSE)
+for more information.

package/action.yml

@@ -0,0 +1,28 @@
+name: 'Changelog Extractor'
+description:
+  'Parse and extract structured information from Keep a Changelog formatted
+  changelogs'
+author: 'Alley Interactive'
+
+branding:
+  icon: 'file-text'
+  color: 'blue'
+
+inputs:
+  changelog-path:
+    description: 'Path to the changelog file'
+    required: false
+    default: 'CHANGELOG.md'
+  version:
+    description:
+      'Specific version to extract (e.g., "1.14.0" or "v1.14.0"). Leave empty to
+      return all versions.'
+    required: false
+
+outputs:
+  result:
+    description: 'JSON array of parsed changelog entries'
+
+runs:
+  using: 'node24'
+  main: 'dist/index.js'