mirror of
https://github.com/di-sukharev/opencommit.git
synced 2026-01-13 07:38:01 -05:00
Compare commits
5 Commits
v1
...
github-act
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1a1134a010 | ||
|
|
d40e2ca4af | ||
|
|
540b4b3bf1 | ||
|
|
0429b92120 | ||
|
|
c6036f0570 |
14
README.md
14
README.md
@@ -5,7 +5,7 @@
|
||||
<h4 align="center">Follow the bird <a href="https://twitter.com/io_Y_oi"><img src="https://img.shields.io/twitter/follow/io_Y_oi?style=flat&label=io_Y_oi&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
|
||||
</h4>
|
||||
</div>
|
||||
<h2>GPT CLI to auto-generate impressive commits in 1 second</h2>
|
||||
<h2>Auto-generate meaningful commits in 1 second</h2>
|
||||
<p>Killing lame commits with AI 🤯🔫</p>
|
||||
<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
|
||||
</div>
|
||||
@@ -18,22 +18,16 @@
|
||||
|
||||
All the commits in this repo are done with OpenCommit — look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is configurable.
|
||||
|
||||
## Setup OpenCommit as a Github Action
|
||||
## Setup OpenCommit as a Github Action 🔥
|
||||
|
||||
OpenCommit is now available as a GitHub Action which automatically improves all new commits messages when you push to remote!
|
||||
|
||||
This is great if you want to make sure all of the commits in all of repository branches are meaningful and not lame like `fix1` or `done2`.
|
||||
|
||||
### Automatic 1 click setup
|
||||
|
||||
You can simply [setup the action automatically via the GitHub Marketplace](TODO).
|
||||
|
||||
### Manual 3 clicks setup
|
||||
|
||||
Create a file `.github/workflows/opencommit.yml` with contents below:
|
||||
|
||||
```yml
|
||||
name: 'OpenCommit'
|
||||
name: 'OpenCommit Action'
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -54,7 +48,7 @@ jobs:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: di-sukharev/opencommit@github-action
|
||||
- uses: di-sukharev/opencommit@github-action-v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: 'OpenCommit — improve commits with AI 🤯🔫'
|
||||
name: 'OpenCommit — improve commits with AI 🧙'
|
||||
description: 'Replaces lame commit messages with meaningful AI-generated messages when you push to remote'
|
||||
author: 'https://github.com/di-sukharev'
|
||||
repo: 'https://github.com/di-sukharev/opencommit/tree/github-action'
|
||||
|
||||
@@ -43,6 +43,7 @@
|
||||
"dev": "ts-node ./src/cli.ts",
|
||||
"build": "rimraf out && node esbuild.config.js",
|
||||
"deploy": "npm run build && npm version patch && npm publish --tag latest",
|
||||
"build:push": "npm run build && git add . && git commit -m 'build' && git push",
|
||||
"lint": "eslint src --ext ts && tsc --noEmit",
|
||||
"format": "prettier --write src"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user