Skip to content

Commit 1fbc33d

Browse files
committed
feat(release): handle file based version and commit
1 parent 377dd84 commit 1fbc33d

File tree

5 files changed

+294
-214
lines changed

5 files changed

+294
-214
lines changed

.commitlog.release

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v0.0.7-dev.6

README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,121 @@
11
![header.png](assets/header.png)
22

3-
# Commitlog
3+
<hr />
4+
<p align="center">
5+
<samp>Changelog generator using Commit History</samp>
6+
</p>
47

5-
Changelog generator using Commit History
6-
7-
![Binary Builds](https://github.com/barelyhuman/commitlog/workflows/Binary%20Builds/badge.svg)
8+
![Binary Builds](https://github.com/barelyhuman/commitlog/workflows/Binary%20Builds/badge.svg)
89
![Binary Builds Pre-Releases](https://github.com/barelyhuman/commitlog/workflows/Binary%20Builds%20Pre-Releases/badge.svg)
910
[![Go Report Card](https://goreportcard.com/badge/github.com/barelyhuman/commitlog)](https://goreportcard.com/report/github.com/barelyhuman/commitlog)
1011
[![commitlog](https://img.shields.io/badge/changelogs-commitlog-blue)](https://github.com/barelyhuman/commitlog)
1112

1213
To see an example of this in action, you can check the actions file for this repo. Yes it uses itself to generate the release logs
1314

1415
## Sheilds | Badges
16+
1517
[![commitlog](https://img.shields.io/badge/changelogs-commitlog-blue)](https://github.com/barelyhuman/commitlog)
18+
1619
```markdown
1720
[![commitlog](https://img.shields.io/badge/changelogs-commitlog-blue)](https://github.com/barelyhuman/commitlog)
1821
```
1922

20-
## Support
23+
## Support
24+
2125
I'd like to keep building more such tools and do them full time instead of doing it during the weekend, help achieve that if you like the tool.
2226

2327
<a href="https://www.buymeacoffee.com/barelyhuman"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=barelyhuman&button_colour=000000&font_colour=ffffff&font_family=Inter&outline_colour=ffffff&coffee_colour=FFDD00"></a>
2428

29+
## Binaries
2530

26-
## Binaries
2731
Binaries are available on the Github [releases](https://github.com/barelyhuman/commitlog/releases)
2832

29-
## Build
33+
## Build
34+
3035
This step is for people who want to use the latest version from the repositories which hasn't been added to releases as a binary yet and for people viewing this on sourcehut , as the binaries aren't uploaded to sourcehut.
3136

3237
- Make sure you have go installed on your system , minimum version `1.15`
33-
- You can either clone the whole repo from sourcehut / github or downlad a tar.gz from sourcehut / github
38+
- You can either clone the whole repo from sourcehut / github or downlad a tar.gz from sourcehut / github
3439

35-
### With Clone
40+
### With Clone
3641

37-
```sh
42+
```sh
3843
git clone https://git.sr.ht/~reaper/commitlog
39-
# or
44+
# or
4045
git clone https://github.com/barelyhuman/commitlog
4146

42-
cd commitlog
43-
go build
47+
cd commitlog
48+
go build
4449
```
4550

46-
### With Tarballs
51+
### With Tarballs
52+
4753
```sh
4854
tar -xvzf commitlog-<hash>.tar.gz
49-
cd commitlog
50-
go build
55+
cd commitlog
56+
go build
5157
```
5258

5359
```sh
5460
# to install it to go's bin folder and use the commitlog command during dev or as a perm install
55-
go install
61+
go install
5662
```
5763

58-
### Web Version
64+
### Web Version
65+
5966
Source: [commitlog-web](https://github.com/barelyhuman/commitlog-web)
6067

6168
Web App: [commitlog-web](https://commitlog-web.herokuapp.com/)
6269

63-
## Usage
70+
## Usage
6471

65-
The usage is pretty simple, this cli tool assumes that you use [commitlint standards](https://github.com/conventional-changelog/commitlint#what-is-commitlint) while writing your commits, if not it's okay everything will be classified under `Other Changes` instead of being grouped according to type of commit.
72+
The usage is pretty simple, this cli tool assumes that you use [commitlint standards](https://github.com/conventional-changelog/commitlint#what-is-commitlint) while writing your commits, if not it's okay everything will be classified under `Other Changes` instead of being grouped according to type of commit.
6673

6774
**Simple Overview**
68-
`ci: <message>` - for ci/cd changes
75+
`ci: <message>` - for ci/cd changes
6976
`feat|feature: <message>` - for feature changes
7077
`docs: <message>` - for documents or comment updations in code
7178
`refactor: <message>` - performance / code clean up changes or total BLOC changes
72-
`fix: <message>` - for fixes (self-explanatory)
73-
79+
`fix: <message>` - for fixes (self-explanatory)
7480

7581
### Supported Flags (as of v0.0.4-dev.3)
7682

77-
The below mentioned are the flags supported by the current branch and older tags might not support the flags
83+
The below mentioned are the flags supported by the current branch and older tags might not support the flags
7884
or certain inputs in flags, use the `-h` flag to see what's supported on the version you are using.
7985

8086
```sh
8187
Usage of commitlog:
8288
-e string
83-
commit hash string / revision (ex. HEAD, HEAD^, HEAD~2)
89+
commit hash string / revision (ex. HEAD, HEAD^, HEAD~2)
8490
to stop collecting commit message at
8591
-i string
8692
commit types to be includes (default "ci,refactor,docs,fix,feat,test,chore,other")
8793
-p string
8894
path to the repository, points to the current working directory by default (default ".")
8995
-s string
90-
commit hash string / revision (ex. HEAD, HEAD^, HEAD~2)
96+
commit hash string / revision (ex. HEAD, HEAD^, HEAD~2)
9197
to start collecting commit messages from
9298
-skip
9399
if true will skip trying to classify and just give a list of changes
94100
```
95101
96-
97102
### Example Output (from this exact repository)
98103
99104
```sh
100-
> commitlog
101-
# which is the shorthand of
105+
> commitlog
106+
# which is the shorthand of
102107
> commitlog log -p .
103108
```
104109
105110
**As of 0.0.6 there's an experimental release subcommand that can be used for version tagging**
106111
107112
```markdown
108113
## Fixes
109-
97c582b3eb5a6796ef9c250d9653ad90dce63cbe - example fix
110114
115+
97c582b3eb5a6796ef9c250d9653ad90dce63cbe - example fix
111116
112117
## Other Changes
118+
113119
da6d837eb3134f836bfbe401de7882f2e0818ba8 - Create LICENSE
114120
b0f1b1d2bc4265cb72b70b3ae5b60f8e65f47b12 - initial commit
115121
```
@@ -119,7 +125,6 @@ b0f1b1d2bc4265cb72b70b3ae5b60f8e65f47b12 - initial commit
119125
- No Tests added so is probably unstable right now ( If you'd like to help writing tests, feel free to raise a PR)
120126
- Doesn't work inside a nested folder in the repository, needs to be on the root of the repository to work. (you can use the `-p` flag to set a path to generate logs from)
121127
122-
123128
## Contribution
124129
125130
[Contribution Guidelines](CONTRIBUTING.md)

0 commit comments

Comments
 (0)