Releases: sethwebster/ava-commit
v0.0.18
Release Notes for v0.0.18
We're excited to announce the release of version 0.0.18! This update brings a new feature that enhances your
workflow and saves you time.
New Features 🚀
-
Push Option in Generate Command: We've added a new
-p, --push
option to thegenerate
command. This feature
allows you to decide if you want to push the generated files to the remote repository. By default, this option is
set to false. This change was made to give you more control over your workflow. -
Push Property in Options Object: We've introduced a new
push
property to theoptions
object in the
generate function. This property determines whether to push the changes to the remote repository. If thepush
property is true, the code will execute thegit.push()
function and display the result. This change was made to
automate the process of pushing commits to the remote repository when generating summaries. -
New Push Function in git.ts: We've added a new function called
push
to thegit.ts
file. This function uses
thespawn
method to execute thegit push
command. This change was made to provide a way to push changes to a
remote repository using the git library. This function can be used to automate the process of pushing commits to a
remote repository. -
New Message Option for Push Description: We've added a new message option called
option-push-description
.
This change was made to provide you with the ability to push to a remote repository after committing changes. This
new option allows for a streamlined workflow by automating the process of pushing changes to the remote repository,
saving you time and effort. -
New Option in CliMessages Type: We've added a new option
option-push-description
to theCliMessages
type
intypes.ts
. This change was made to enhance the user experience by providing more descriptive messages.
v0.0.17
Adds hashbang
v0.0.15
Release Notes for v0.0.15
Simplified User Interaction
In our continuous effort to make our product more user-friendly and intuitive, we've simplified the
"accept-which-summary" message in the "Messages" object. We've removed the options for selecting
different actions, leaving only the question itself. This change was made across multiple languages to
ensure a consistent user experience for all our users, regardless of their language preference.
This change is aimed at reducing complexity and making the interaction more straightforward. We
believe that by removing unnecessary options, we can help users make decisions more quickly and
easily.
Version Update
We've updated the version number in the package.json file from 0.0.14 to 0.0.15. This change reflects
the modifications we've made in this release and helps keep track of the product's evolution.
🤖 Generated with Ava Commit
v0.0.14
Release Notes for v0.0.14
Hello, world! 🌍 We're excited to bring you the latest updates to our project. Here's what's new:
Removed Redundant Code 🧹
We've removed the 'consoleHelpers.ts' file. It was no longer needed in our project context, making our codebase leaner and more focused.
Code Refactoring for Better User Experience 🔄
We've refactored our code to improve maintainability and readability. We've moved types for CLI messages, prompts, and possible answers to a separate file. This reduces complexity and enhances the user experience with new messages supporting more user interactions.
Improved Code Modularity and Configurability 🧩
We've made changes to improve code modularity and configurability in the summarization functions. Now, previously hard-coded values and templates are loaded from a configuration file and a separate template file. This allows for easier updates, potential customization, reduces code duplication, and enhances readability.
Support for Multiple AI Models and Languages 🌐
We've made changes to define types and constants for a new feature that supports multiple AI models and languages in a CLI application. This enhances the application's flexibility and internationalization capabilities, allowing it to handle different AI models and support multiple languages.
Stay tuned for more updates. Happy coding! 🚀
🤖 Generated with Ava Commit
v0.0.13
Release notes for v0.0.13
New Features
- A new option
-v,--verbose
has been added to therelease-notes
command. This option can be used to enable verbose output when creating release notes.
Updates
- The
releaseNotes.ts
file has been updated to import thecountWords
function from the "alfaaz" module. ThecreateReleaseNotes
function now includes a word count in the output. - The
summarize.ts
file has been updated to import thecountWords
function from the 'alfaaz' module and theChainValues
interface from the 'langchain/schema' module. ThesummarizeDiff
function now includes a timeout for the promise and a try-catch-finally block to handle potential errors. ThecombineSummaries
andsummarizeSummaries
functions now include the word count in the progress messages.
Dependency Changes
- A new dependency called "alfaaz" with version "^1.1.0" has been added to the list of dependencies.
Other Changes
- The
pnpm-lock.yaml
file has been updated to include a new dependency "alfaaz" with version 1.1.0, a resolution for the "alfaaz" dependency, and the removal of the "settings" section. TheautoInstallPeers
setting is set to true andexcludeLinksFromLockfile
is set to false.
v0.0.12
Release Notes for v0.0.12
What's New
Updated README.md
We've added a handy table to our README.md file that lists all the commands and options available in our tool. This includes update
, release-notes
, configure
, and generate
. We've also provided examples of how to use the tool and a section on how to customize the tool's settings.
Languages
- Added support for internationalizing the help text the tool displays and updated English, Spanish, Russian, Italian, and French.
Russian & Spanish Languages Added
- Added Russian and Spanish
v0.0.11
Release notes for v0.0.11
New Features
- Auto update now gives you the opportunity to update from within the cli.
v0.0.10
Release Notes for v0.0.10
New Features
- New Commands: We've added new commands to the
program
object:release-notes
,configure
, andgenerate
. Thegenerate
command has been further enhanced with additional options and help text. (#0) - Localized Messages: We've made our tool more user-friendly for international users. Messages are now localized and can be displayed in multiple languages. (#2, #3, #8)
- Generate Summaries: A new function called "generate" has been added to the "generate.ts" file. This function uses the OpenAI API to generate summaries based on commit messages. (#4)
- Fetch and Tags Functions: Two new async functions,
fetch
andtags
, have been added. These functions execute the "git fetch" and "git tag" commands respectively and return promises. (#6) - Invariant Function: A new function called "invariant" has been added. This function checks a condition and throws an error with a given message if the condition is false. (#7)
- Release Notes Generation: A new file called "releaseNotes.ts" was added. This file contains a function called "createReleaseNotes" that fetches git tags, retrieves the differences between the latest tag and the current state, and summarizes the differences using an OpenAI model. (#9)
Improvements
- Check Staged Commits: The
checkStagedCommits
function now accepts an optionaloptions
parameter and uses localized messages for console outputs. (#1) - Diff Function: The diff function in the git.ts file has been updated to accept an optional options parameter, allowing for more customized behavior. (#5)
- Summarize Function: The summarize function now accepts an optional verbose parameter, allowing for more detailed output. (#10)
Fixes
- Language Configuration: The
cliLanguage
andcommitMessageLanguage
options in theDEFAULT_CONFIG
object were corrected from "en-us" to "en-US". (#2)
Other Changes
- Message Updates: Console output messages have been updated to be language-specific and use template strings. (#11)
v0.0.9
bugfix: configure wasn't properly waiting
v0.0.8
We're thrilled to announce the release of Ava-commit v0.0.8, packed with some remarkable updates to improve your experience!
✨ New Features
-
Ava-commit CLI Enhanced: We've significantly improved the user interaction within the command-line tool, including additional prompts and refined commit message options. The commit process now includes a prompt for summary acceptance to ensure your final review before committing.
-
Summarize Function Updates: Enjoy the benefits of our refined summarize.ts function, including the prioritization of added code over changes to package lock files and excluding import messages.
🛠️ Improvements
-
Improved Workflow File: The GitHub workflow file now benefits from a new step to use the pnpm/action-setup with version 8 and updated Node.js version to 16, improving the efficiency of your workflows.
-
Automated Configuration: The project has been renamed to "@sethwebster/ava-commit", and the configuration process is now automated. This release also includes an update to the README.md file with accurate installation instructions.
-
Caching Functionality: We introduced automatic caching of previous run, improving performance, in case you accidentally bail on a commit. If the diffs haven't changed, there's no need to re-summarize. Added the [r] option to regenerate if you do want to have new commit message options.
🐛 Bug Fixes
- NPM Install Command Corrected: The npm install command in README.md was corrected to "npm install @sethwebster/ava-commit", ensuring accurate installation instructions.
Remember, you can get the new update with the following command: npm install @sethwebster/ava-commit.