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
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,15 @@ $ yarn add global semantic-git-release-cli
28
28
29
29
## Usage
30
30
31
+
-[Release a new version](#release-a-new-version)
32
+
-[Recover the complete changelog](#recover-the-complete-changelog)
33
+
34
+
### Release a new version
35
+
36
+
If you start using `semantic-git-release-cli` with a brand new project simply start in this section.
37
+
38
+
If you already released some verions of your project, you might consider to [recover the complete changelog first](#recover-the-complete-changelog).
39
+
31
40
Forget the times when you had to manually write changelogs, update versions, tag commits. Now just type:
32
41
33
42
```sh
@@ -40,7 +49,7 @@ or if you already have an alias for sgr, use following instead:
40
49
$ semantic-git-release
41
50
```
42
51
43
-
## Tasks
52
+
####Tasks
44
53
45
54
So there are a few tasks `semantic-git-release-cli` will do for you:
46
55
@@ -50,13 +59,15 @@ So there are a few tasks `semantic-git-release-cli` will do for you:
50
59
- creates or updates the `CHANGELOG.md`
51
60
- commits and tags the new `version`
52
61
53
-
## Recover the CHANGELOG.md
62
+
###Recover the complete changelog
54
63
55
64
If you are start to use `semantic-git-release-cli` but already released (and tagged) versions. Simply use the recover mode.
56
65
66
+
If `--recover` is set to `backup` it will generate a backup file of your current `CHANGELOG.md` inside of the `.sgr_backup` directory, which gets generated the first time you use this command inside of your current working directory.
67
+
57
68
```sh
58
-
# generates the complete CHANGELOG.md
59
-
sgr --recover # or short `sgr -r`
60
-
# generates the complete CHANGELOG.md and creates a backup of the current CHANGELOG.md in .sgr_backup
61
-
sgr -r backup # or short `sgr -r b`
69
+
# generates the complete CHANGELOG.md without backup
0 commit comments