Try the new Generate Commit Message (Experimental)

[SpaceMerlin33]

We’ve introduced a new experimental feature to assist with writing commit messages by leveraging OpenAI.

To start, stage some changes you want to commit and generate a commit message for and then run the “Generate Commit Message (Experimental)” command from the Command Palette. From there you will be guided through the process of accepting to send the diff of your staged changes to OpenAI and the entry of your OpenAI key. Once completed, the generated commit message will be entered into the commit input box on the Source Control sidebar. You can also enter additional context about your changes in the commit box and those will also be sent to help generate a better message.

Additionally, you can customize the gitlens.experimental.generateCommitMessagePrompt setting to control the prompt used to structure and format the generated commit message. You could have it structure commit messages in the conventional commit style, or you can have fun with it and make your commit messages in the style of a pirate, Shakespeare, etc.

This is a very early peek into features and ideas that can leverage AI – with more planned in the near future. We're excited to bring this experimental feature to you and are ready to answer any questions and make improvements where needed.

We'd love to hear your feedback! 🙏

[gllsrssx]

works well but i cannot change openai api key

[jkelroy]

I see you answered this here, but will include the answer to this thread as well: run the command GitLens: Reset Stored OpenAI Key from the Command Palette.

[PeterNjeim]

This is great, however I don't want to pay for an OpenAI key. Maybe in the future you can use open source models like LAION OpenAssistant, HuggingChat, or the new Falcon-Chat (currently not tuned for code but it is the best open source LLM currently)

[jkelroy]

GitLens currently supports OpenAI and Anthropic. I created a feature request to support additional models here. #2743 (comment)

[lestephane]

Can it be coerced into generating conventional commits? https://www.conventionalcommits.org

[jkelroy]

Do you have the string wrapped in quotes in your settings.json? To check this, open the command palette (ctrl/command + shift + P) and search Preferences: Open User Settings (JSON). The entry should look like this - if you have more settings before or after, make sure to include a , after each entry:

{
    "gitlens.experimental.generateCommitMessagePrompt": "Generate a commit message using the Conventional Commits format. Examples: ['feat: Add new feature to the project', 'fix: Fix a bug in the project', 'chore: Update build configuration or task', 'docs: Update project documentation', 'style: Update code formatting or style', 'refactor: Refactor existing code', 'test: Add or update tests', 'perf: Improve performance of the project', 'ci: Update continuous integration configuration', 'build: Make changes related to the build process', 'revert: Revert a previous commit']"
}

[LukasPolak]

{
  "gitlens.experimental.generateCommitMessagePrompt": "Generate a commit message using the Conventional Commits format. Examples: ['feat: Add new feature to the project', 'fix: Fix a bug in the project', 'chore: Update build configuration or task', 'docs: Update project documentation', 'style: Update code formatting or style', 'refactor: Refactor existing code', 'test: Add or update tests', 'perf: Improve performance of the project', 'ci: Update continuous integration configuration', 'build: Make changes related to the build process', 'revert: Revert a previous commit']"
}

I verified the validity of the JSON, and it is valid. Additionally, the other settings are functioning properly.

[jkelroy]

I see, so the commit message is being generated but seemingly just not getting the desired output based on the prompt. What AI provider and model are you using?

[LukasPolak]

Yes, that is right

  "gitlens.ai.experimental.provider": "openai",
  "gitlens.ai.experimental.openai.model": "gpt-3.5-turbo",

[LukasPolak]

I realized I used GitHub Copilot instead of GitLens to generate commit messages.
Apologies for the inconvenience and thank you for the prompt responses!

[mikernet]

I'm not sure if github copilot has integration points that can be leveraged so it can be used as a commit message provider in GK or not. Are there any plans to support this scenario? Would be nice, given that we already have subs for that.

[jkelroy]

There is an existing feature request to support additional AI models: #2743