1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
---
title: "Quick Start"
description: Quick guide on how to get started with changie.
---
> Before starting, if you already have a `CHANGELOG.md` read the
> [backup guide](backup.md) first.
Run `init` to bootstrap your project with a sample config, header and empty changelog.
```sh
changie init
```
You can [configure](../config/index.md) changie by editing the generated `.changie.yaml` file.
When completing work on a feature, bugfix or user impacting change use the new command
to generate your change file.
```sh
changie new
```
When it is time to prepare your next release, batch all unreleased changes into one using the batch command.
```sh
# changie supports semver bump values
changie batch <major|minor|patch>
# using an explicit version
changie batch <version>
# or using auto if you have kinds configured for auto bumps
changie batch auto
```
After you have batched a new version you can merge it into the parent changelog using the merge command.
```sh
changie merge
```
<video controls>
<source src="/static/quick_start.webm" type="video/webm">
</video>
|
