Skip to content

Commit dd86290

Browse files
authored
docs: 📝 add upgrade guide & other (#28)
* docs: 📝 add upgrade guide & other * 0.7.9
1 parent b79558d commit dd86290

File tree

2 files changed

+56
-1
lines changed

2 files changed

+56
-1
lines changed

README.md

+55
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,30 @@ This module is a wrapper of the NPM module [git-scripts](https://www.npmjs.com/p
1717

1818
Learn more about the original `git-scripts` from its GitHub homepage: [git-scripts](https://github.com/nkzawa/git-scripts)
1919

20+
## Preview
21+
22+
- Fail
23+
24+
![image](https://user-images.githubusercontent.com/5285894/163552995-87d0e331-568d-430c-b323-a076279e637a.png)
25+
26+
- Success
27+
28+
![image](https://user-images.githubusercontent.com/5285894/163553127-23538ade-c321-4028-b0e5-806097cae2a8.png)
29+
30+
## Use
31+
32+
Frist push:
33+
34+
- `git push -u origin branch`
35+
36+
If you don't want to need to add the -u parameter every time, you can modify default settings for git.
37+
38+
- `git config --global push.default current`
39+
40+
After that just use:
41+
42+
- `git push`
43+
2044
## DISABLE THE HOOK
2145

2246
You can skip git hook for `pre-push` if you want.
@@ -46,10 +70,41 @@ To permanent disable the `pre-push` git hook, you can delete the related setting
4670
- }
4771
```
4872

73+
## Upgrade from old version
74+
75+
In the v0.7 version, we have improved the user experience. Solve the problem of push blocking and improve the readability of output information.
76+
All projects using @chatie/scripts are highly recommended to upgrade.
77+
78+
Link to [Issue #27](https://github.com/Chatie/git-scripts/issues/27)
79+
80+
### Upgrade guide
81+
82+
Update steps:
83+
84+
1. `npm i -D @chatie/scripts@next`
85+
2. `npx git-scripts install`
86+
3. Enjoy push
87+
4988
## CHANGELOG
5089

5190
### master
5291

92+
### v0.7.8 (12 Apr 2022 )
93+
94+
1. fix ts-node not found bug
95+
96+
### v0.7.6 (12 Apr 2022 )
97+
98+
1. Improve readability of output messages
99+
100+
### v0.7.4 (10 Apr 2022 )
101+
102+
1. Remove git tag
103+
104+
### v0.7 (08 Apr 2022 )
105+
106+
1. Fix re-push produces meaningless version when push fails after
107+
53108
### v0.2 (10 Jun 2019)
54109

55110
1. Install hook to `package.json` automatically

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chatie/git-scripts",
3-
"version": "0.7.8",
3+
"version": "0.7.9",
44
"description": "Git Hooks Integration for Chatie Projects",
55
"directories": {
66
"doc": "docs",

0 commit comments

Comments
 (0)