git-aicommit 7.0.1 → 7.2.0

package/.github/workflows/auto-release.yaml

@@ -0,0 +1,73 @@
+name: Auto Release on Version Change
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Get Version from package.json
+        id: get_version
+        run: echo "version=$(jq -r '.version' package.json)" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - name: Check if tag exists remotely
+        id: check_tag
+        run: |
+          PACKAGE_VERSION="${{ steps.get_version.outputs.version }}"
+          TAG_NAME="v${PACKAGE_VERSION}" # Standard v-prefix for tags
+          echo "Checking for remote tag: ${TAG_NAME}"
+
+          TAG_EXISTS_COUNT=$(git ls-remote --tags origin "refs/tags/${TAG_NAME}" | wc -l)
+
+          if [ "$TAG_EXISTS_COUNT" -ne 0 ]; then
+            echo "Tag ${TAG_NAME} already exists remotely."
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "Tag ${TAG_NAME} does not exist remotely. Proceeding."
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+        shell: bash
+
+      - name: Fail workflow if tag already exists
+        if: steps.check_tag.outputs.exists == 'true'
+        run: |
+          PACKAGE_VERSION="${{ steps.get_version.outputs.version }}"
+          TAG_NAME="v${PACKAGE_VERSION}"
+          echo "::error title=Tag Exists::Tag ${TAG_NAME} already exists. Halting release process."
+          exit 1 # This will fail the job and stop further execution
+        shell: bash
+
+      - name: Create Release (and Git Tag)
+        uses: actions/create-release@v1
+        with:
+          tag_name: v${{ steps.get_version.outputs.version }}
+          release_name: Release v${{ steps.get_version.outputs.version }}
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3 # Can update to v4 if available and desired
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/README.md

@@ -36,30 +36,33 @@ touch $HOME/.git-aicommitrc
 // $HOME/.git-aicommitrc
 export default {
     openAiKey: process.env.OPENAI_API_KEY,
-    addAllChangesBeforeCommit: true,
+    azureOpenAiKey: process.env.AZURE_OPENAI_API_KEY,
+    azureOpenAiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME,
+    azureOpenAiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME,
+    azureOpenAiVersion: process.env.AZURE_OPENAI_API_VERSION,
     autocommit: true,
     openCommitTextEditor: false,
     language: 'english',
     systemMessagePromptTemplate: '' +
-        'You are expert AI, your job is to write clear and concise Git commit messages.' +
+        'You are expert software developer, your job is to write clear and concise Git commit messages. ' +
         'Your responsibility is to ensure that these messages accurately describe the changes made in each commit,' +
         'follow established guidelines. Provide a clear history of changes to the codebase.' +
         'Write 1-2 sentences. Output only the commit message without comments or other text.',
     humanPromptTemplate: '' +
         'Read the following git diff for a multiple files and ' +
         'write 1-2 sentences commit message in {language}' +
-        'without mentioning lines or files:\n' +
+        'without mentioning lines or files.' +
+        'If the reason behind the changed can be deducted from the changed, provide this reason:\n' +
         '{diff}',
     excludeFromDiff: [
-        '*.lock', '*.lockb'
+        '*.lock', '*.lockb', '*-lock.json', '*-lock.yaml'
     ],
     diffFilter: 'ACMRTUXB',
-    completionPromptParams: {
-        model: "gpt-4o-mini",
-        temperature: 0.0,
-        maxTokens: 1000,
-    }
+    modelName: "gpt-4.1-mini",
+    temperature: 0.0,
+    maxTokens: 2000,
 }
+
 ```
 
 ### Command line arguments
@@ -77,7 +80,7 @@ git-aicommit
 Or make an alias:
 
 ```bash
-alias gai='git-aicommit'
+alias gai="git add --all && git-aicommit && git push"
 
 ## And run it:
 gai

package/autocommit.js

@@ -58,12 +58,13 @@ if (!diff) {
 const openai = new OpenAI({
     apiKey: config.openAiKey,
     baseURL: config.azureOpenAiKey ? `https://${config.azureOpenAiInstanceName}.openai.azure.com/openai/deployments/${config.azureOpenAiDeploymentName}` : undefined,
-    defaultHeaders: config.azureOpenAiKey ? { 'api-key': config.azureOpenAiKey } : undefined
+    defaultHeaders: config.azureOpenAiKey ? { 'api-key': config.azureOpenAiKey } : undefined,
+    defaultQuery: config.azureOpenAiKey ? { 'api-version': config.azureOpenAiVersion } : undefined, // defaultQuery for api-version as per OpenAI SDK v4+ for Azure
 });
 
 async function getChatCompletion(messages) {
     const response = await openai.chat.completions.create({
-        model: config.modelName || 'gpt-4o-mini',
+        model: config.modelName || 'gpt-4.1-mini',
         messages: messages,
         temperature: config.temperature,
         max_tokens: config.maxTokens,
@@ -75,24 +76,21 @@ async function getChatCompletion(messages) {
 const systemMessage = { role: "system", content: config.systemMessagePromptTemplate };
 const userMessage = { role: "user", content: config.humanPromptTemplate.replace("{diff}", diff).replace("{language}", config.language) };
 
-const chatMessages = [systemMessage, userMessage];
-
 const tokenCount = await calculateMaxTokens({
     prompt: diff,
-    modelName: config.modelName || 'gpt-4o-mini'
+    modelName: config.modelName || 'gpt-4.1-mini'
 });
 
-const contextSize = getModelContextSize(config.modelName || 'gpt-4o-mini');
+const contextSize = getModelContextSize(config.modelName || 'gpt-4.1-mini');
 
 if (tokenCount > contextSize) {
-    console.log('Diff is too long. Please lower the amount of changes in the commit or switch to a model with bigger context size');
-
+    console.log('Diff is too long for the current model context. Please lower the amount of changes in the commit or switch to a model with a larger context window.');
     process.exit(1);
 }
 
 const messages = [
-    { role: "system", content: config.systemMessagePromptTemplate },
-    { role: "user", content: config.humanPromptTemplate.replace("{diff}", diff).replace("{language}", config.language) }
+    systemMessage,
+    userMessage
 ];
 
 const commitMessage = await getChatCompletion(messages);
@@ -101,10 +99,19 @@ if (!config.autocommit) {
     console.log(`Autocommit is disabled. Here is the message:\n ${commitMessage}`);
 } else {
     console.log(`Committing with following message:\n ${commitMessage}`);
-    execSync(
-        `git commit -m "${commitMessage.replace(/"/g, '')}"`,
-        {encoding: 'utf8'}
-    );
+    try {
+        execSync(
+            'git commit -F -',
+            {
+                input: commitMessage,
+                encoding: 'utf8',
+                stdio: 'inherit'
+            }
+        );
+    } catch (error) {
+        console.error("Failed to commit.", error);
+        process.exit(1);
+    }
 }
 
 if (config.openCommitTextEditor) {

package/config.js

@@ -22,7 +22,7 @@ export default {
         '*.lock', '*.lockb', '*-lock.json', '*-lock.yaml'
     ],
     diffFilter: 'ACMRTUXB',
-    modelName: "gpt-4o-mini",
+    modelName: "gpt-4.1-mini",
     temperature: 0.0,
     maxTokens: 2000,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-aicommit",
-  "version": "7.0.1",
+  "version": "7.2.0",
   "description": "Generates auto commit messages with OpenAI GPT3 model",
   "main": "autocommit.js",
   "repository": "https://github.com/shanginn/autocommit",
@@ -8,9 +8,9 @@
   "license": "MIT",
   "type": "module",
   "dependencies": {
-    "openai": "^4.52.7",
+    "openai": "^4.100.0",
     "rc": "^1.2.8",
-    "tiktoken": "^1.0.15"
+    "tiktoken": "^1.0.21"
   },
   "preferGlobal": true,
   "bin": {

package/.github/workflows/npm-publish.yml

@@ -1,19 +0,0 @@
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}