File tree Expand file tree Collapse file tree 1 file changed +20
-4
lines changed Expand file tree Collapse file tree 1 file changed +20
-4
lines changed Original file line number Diff line number Diff line change @@ -17,17 +17,33 @@ history of how it looked like before merging, including the individual commits).
17
17
If you are stuck on "traditional" merge mode in your projects, you can still use the tool. It's just that its output will be less
18
18
readable because of all the individual commits that are retained + one extra merge commit for every single PR.
19
19
20
- ## How to run
20
+ ## Prerequisites
21
+
22
+ ## How to install
21
23
22
24
``` shell
23
- # This downloads the rust toolchain. You can omit this step if you already have a suitable Rust version installed.
24
- curl https://sh.rustup.rs -sSf | sh
25
+ $ cargo install changelog-rs
26
+ ```
25
27
28
+ You will then have a ` changelog-rs ` in your path which you can run like this:
29
+
30
+ ``` shell
26
31
# If you want to generate a changelog entry for a particular version (from-revision and to-revision can be any git ref, i.e. a tag
27
32
# or a git commit SHA etc.
28
- cargo run < repo> < from-revision> < to-revision>
33
+ $ changelog-rs < repo> < from-revision> < to-revision>
29
34
30
35
# If you want to generate changelog entries for all versions that are tagged with SemVer compliant tags.
36
+ $ changelog-rs < repo>
37
+ ```
38
+
39
+ ## How to build and run
40
+
41
+ ``` shell
42
+ # This downloads the rust toolchain. You can omit this step if you already have a suitable Rust version installed.
43
+ curl https://sh.rustup.rs -sSf | sh
44
+
45
+ # Same parameter modes as above can be used.
46
+ cargo run < repo> < from-revision> < to-revision>
31
47
cargo run < repo>
32
48
```
33
49
You can’t perform that action at this time.
0 commit comments