Releases: davegarvey/bubble
Releases · davegarvey/bubble
v1.1.1
Release 1.1.1
This release focuses on reliability of git parsing, improvements to the AI-based release-note generation, and updates to CI and documentation.
Breaking Changes
- Change OpenAI integration to the Responses API and update token parameter name:
- Update any custom integrations or configurations that rely on the previous OpenAI API parameters (max_tokens) or the older completions API.
- Remove unsupported grubble GitHub Action inputs:
- Stop using git-user-name and git-user-email action inputs in workflows that call the grubble GitHub Action; these inputs are no longer supported by the action.
Features
- Migrate OpenAI provider to the Responses API to align with the latest OpenAI offering and improve model interaction.
Bug Fixes
- Fix git parsing errors:
- Prevent crashes when commits have empty bodies by making git log parsing more robust.
- Fix CI token handling:
- Correct GITHUB_TOKEN usage in workflows and update documentation to prevent CI failures related to token handling.
Improvements
- Reduce AI temperature to produce more consistent release notes.
- Remove explicit temperature parameter from OpenAI calls to let the provider control defaults.
- Replace max_tokens with max_completion_tokens for OpenAI requests to match current API expectations.
Documentation
- Improve README formatting for clearer usage and setup instructions.
- Update CI workflow documentation to reflect changes in token handling and action inputs.
CI / Developer Workflow
- Update CI workflows to use newer grubble action versions and switch the version workflow to a Rust bumper tool.
- Remove invalid or unsupported grubble action inputs from workflows to prevent CI errors.
If you maintain CI workflows or custom OpenAI integrations, please review and update your configurations to accommodate the breaking changes above.
v1.1.0
Release 1.1.0
Summary: This release adds an AI-powered CLI for generating release notes, includes project configuration for a Node.js tool, and provides comprehensive documentation and onboarding materials.
Features
- Introduce an AI-powered release notes generator available as a CLI tool.
- Analyze git commits between tags to produce structured release notes.
- Create GitHub releases directly from the CLI using the GitHub API.
- Support multiple AI providers to give flexibility in choice of model/provider.
Documentation
- Add a comprehensive README covering installation, configuration, and usage.
- Include CLI usage examples and available options to simplify day-to-day use.
- Provide GitHub Actions workflow examples to help automate release workflows.
- Present a feature overview with practical examples to demonstrate capabilities.
Setup & Configuration
- Provide Node.js project configuration and required dependencies for the CLI.
- Ship an environment variables template to simplify API key and configuration setup.
- Add sensible .gitignore rules to streamline repository setup and development.
Note: The CLI requires a Node.js runtime to run.
Miscellaneous
- Bump package version to 1.1.0.
Breaking Changes
- None.