You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -143,16 +143,17 @@ In order to see it in action, you'll need a repository that already has some of
143
143
2. Ensure you already `clog` binary from any of the steps above
144
144
145
145
4. There are many, many ways to run `clog`. Note, in these examples we will be typing the same options over and over again, intimes like that we could a [clog TOML configuration file](https://github.com/clog-tool/clog-cli#default-options) to specify those options that don't normally change. Also note, all these CLI options have short versions as well, we're using the long version because they're easier to understand.
146
-
a. Let's start by picking up only new commits since our last release (this may not be a lot...or none)
147
-
b. Run `clog -r https://github.com/clog-tool/clog-cli --outfile only_new.md`
148
-
c. By default, `clog` outputs to `stdout` unless you have a file set inside a TOML configuration file. (Note, we could have used the shell `>` operator instead of `--outfile`)
149
-
d. Anything options you set via the CLI will override anything you set the configuration file.
150
-
e. Let's now tell `clog` where it can find our old changelog, and prepend any new commits to that old data
151
-
f. Run `clog -r https://github.com/clog-tool/clog-cli --infile changelog.md --outfile new_combined.md`
152
-
g. Finally, let's assume like most projects we just want to use one file, and prepend all new data to our old changelog (most useful)
153
-
h. First make a backup of the `changelog.md` so you can compare it later `cp changelog.md changelog.md.bak`
154
-
i. Run `clog -r https://github.com/clog-tool/clog-cli --changelog changelog.md`
155
-
j. Try viewing any of the `only_new.md`, `new_combined.md`, `changelog.md.bak`, or `changelog.md`in your favorite markdown viewer to compare them.
146
+
147
+
1. Let's start by picking up only new commits since our last release (this may not be a lot...or none)
148
+
2. Run `clog -r https://github.com/clog-tool/clog-cli --outfile only_new.md`
149
+
3. By default, `clog` outputs to `stdout` unless you have a file set inside a TOML configuration file. (Note, we could have used the shell `>` operator instead of `--outfile`)
150
+
4. Anything options you set via the CLI will override anything you set the configuration file.
151
+
5. Let's now tell `clog` where it can find our old changelog, and prepend any new commits to that old data
152
+
6. Run `clog -r https://github.com/clog-tool/clog-cli --infile changelog.md --outfile new_combined.md`
153
+
7. Finally, let's assume like most projects we just want to use one file, and prepend all new data to our old changelog (most useful)
154
+
8. First make a backup of the `changelog.md` so you can compare it later `cp changelog.md changelog.md.bak`
155
+
9. Run `clog -r https://github.com/clog-tool/clog-cli --changelog changelog.md`
156
+
10. Try viewing any of the `only_new.md`, `new_combined.md`, `changelog.md.bak`, or `changelog.md`in your favorite markdown viewer to compare them.
0 commit comments