chore(README.md): update setup instructions for OpenCommit as a GitHub Action

fix(commit.ts): check if OCO_MESSAGE_TEMPLATE_PLACEHOLDER exists before replacing it in the commit message template The README.md file has been updated to reflect the changes in the setup instructions for using OpenCommit as a GitHub Action. The new instructions provide a file template for the GitHub Action workflow and include the latest version of the OpenCommit GitHub Action. In the commit.ts file, a fix has been made to check if the OCO_MESSAGE_TEMPLATE_PLACEHOLDER exists before replacing it in the commit message template. This ensures that the replacement is only performed when the placeholder is present, preventing any potential errors.
formatting
2026-01-13 15:47:58 -05:00 · 2023-09-03 14:56:57 +08:00 · 2023-09-03 14:39:15 +08:00 · 2023-09-03 14:39:05 +08:00 · 2023-09-03 14:39:01 +08:00 · 2023-09-03 14:10:56 +08:00
4 changed files with 6 additions and 11 deletions
--- a/.opencommitignore
+++ b/.opencommitignore
@@ -1 +0,0 @@
-out
--- a/README.md
+++ b/README.md
@@ -326,8 +326,4 @@ Interactive rebase (`rebase -i`) changes commits' SHA, so the commit history in

 ## Payments

-You pay for your requests to OpenAI API on your own.
-
-OpenCommit stores your key locally.
-
-OpenCommit by default uses ChatGPT (3.5-turbo-16k) official model, which is a lot cheaper than gpt-4.
+You pay for your requests to OpenAI API. OpenCommit uses ChatGPT (3.5-turbo) official model, which is ~15x times cheaper than GPT-4.
--- a/out/cli.cjs
+++ b/out/cli.cjs
@@ -16384,7 +16384,7 @@ function G3(t, e2) {
 // package.json
 var package_default = {
  name: "opencommit",
-  version: "3.0.0",
+  version: "2.4.2",
  description: "Auto-generate impressive commits in 1 second. Killing lame commits with AI \u{1F92F}\u{1F52B}",
  keywords: [
    "git",
@@ -16426,7 +16426,7 @@ var package_default = {
    dev: "ts-node ./src/cli.ts",
    build: "rimraf out && node esbuild.config.js",
    "build:push": "npm run build && git add . && git commit -m 'build' && git push",
-    deploy: "npm run build:push && npm version patch && git push --follow-tags && npm publish --tag latest",
+    deploy: "npm run build:push && npm version patch && git push --tags && git push && npm publish --tag latest",
    lint: "eslint src --ext ts && tsc --noEmit",
    format: "prettier --write src"
  },
@@ -22312,7 +22312,7 @@ var generateCommitMessageFromGitDiff = async (diff, extraArgs2) => {
  try {
    let commitMessage = await generateCommitMessageByDiff(diff);
    const messageTemplate = checkMessageTemplate(extraArgs2);
-    if (config7?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER && typeof messageTemplate === "string") {
+    if (typeof messageTemplate === "string") {
      commitMessage = messageTemplate.replace(
        config7?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
        commitMessage
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "opencommit",
-  "version": "3.0.0",
+  "version": "2.4.2",
  "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
  "keywords": [
    "git",
@@ -42,7 +42,7 @@
    "dev": "ts-node ./src/cli.ts",
    "build": "rimraf out && node esbuild.config.js",
    "build:push": "npm run build && git add . && git commit -m 'build' && git push",
-    "deploy": "npm run build:push && npm version patch && git push --follow-tags && npm publish --tag latest",
+    "deploy": "npm run build:push && npm version patch && git push --tags && git push && npm publish --tag latest",
    "lint": "eslint src --ext ts && tsc --noEmit",
    "format": "prettier --write src"
  },
Author	SHA1	Message	Date
di-sukharev	c30474b473	chore(README.md): update setup instructions for OpenCommit as a GitHub Action fix(commit.ts): check if OCO_MESSAGE_TEMPLATE_PLACEHOLDER exists before replacing it in the commit message template The README.md file has been updated to reflect the changes in the setup instructions for using OpenCommit as a GitHub Action. The new instructions provide a file template for the GitHub Action workflow and include the latest version of the OpenCommit GitHub Action. In the commit.ts file, a fix has been made to check if the OCO_MESSAGE_TEMPLATE_PLACEHOLDER exists before replacing it in the commit message template. This ensures that the replacement is only performed when the placeholder is present, preventing any potential errors.	2023-09-03 14:56:57 +08:00
di-sukharev	c986512e73	formatting	2023-09-03 14:39:15 +08:00
di-sukharev	49f109be24	build	2023-09-03 14:39:05 +08:00
di-sukharev	41a88eefff	improve text	2023-09-03 14:39:01 +08:00
di-sukharev	765e9884dd	chore(package.json): reorder scripts to improve readability and maintainability	2023-09-03 14:10:56 +08:00
di-sukharev	ea9411fa69	build	2023-09-03 14:09:45 +08:00
Sébastien Fichot	12956d7633	feat: Integrate @commitlint for Enhanced Commit Message Generation and Configuration Support (#209 ) * add commitlint support * refactor code * improve readme text	2023-09-03 14:00:18 +08:00
Malthe Poulsen	c1627bb98c	🔧 chore(github-action.ts): add check for changes in commit messages before rebasing to improve efficiency (#222 ) 🐛 fix(github-action.ts): fix logic to check if there are any changes in commit messages before rebasing to ensure correct behavior	2023-09-03 12:22:05 +08:00
Max Zavodniuk	4e374aa9db	fix(config.ts): pass config object to configValidators[CONFIG_KEYS.OCO_OPENAI_API_KEY] to allow access to other config values (#225 ) * any length `OCO_OPENAI_API_KEY` if `OCO_OPENAI_BASE_PATH` is set	2023-09-03 12:21:13 +08:00
E Einowski	ef003bdad6	Add Detailed Explanation of OCO_MESSAGE_TEMPLATE_PLACEHOLDER Feature to README.md (#242 ) * 📝 docs(README.md): add detailed explanation of OCO_MESSAGE_TEMPLATE_PLACEHOLDER feature	2023-09-03 12:18:10 +08:00