@twistezo/ai-review-council 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,15 +12,15 @@ Changes: [CHANGELOG.md](CHANGELOG.md). Internals: [ARCHITECTURE.md](ARCHITECTURE
|
|
|
12
12
|
## Run
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
+
# install
|
|
15
16
|
npm install -g @twistezo/ai-review-council
|
|
16
|
-
```
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
# every option is optional and skips its wizard question
|
|
18
|
+
# run; every option is optional and skips its wizard question
|
|
20
19
|
ai-review-council --dir ~/projects/my-app --lang pl --scope uncommitted --reviewers 2
|
|
21
|
-
```
|
|
22
20
|
|
|
23
|
-
|
|
21
|
+
# or run without installing
|
|
22
|
+
npx @twistezo/ai-review-council
|
|
23
|
+
```
|
|
24
24
|
|
|
25
25
|
| Option | Value | Default |
|
|
26
26
|
|---|---|---|
|
|
@@ -61,29 +61,33 @@ A new review type needs a file in both folders and an entry in `reviewTypes` in
|
|
|
61
61
|
## Develop
|
|
62
62
|
|
|
63
63
|
```bash
|
|
64
|
+
# install dependencies
|
|
64
65
|
npm install
|
|
65
|
-
```
|
|
66
66
|
|
|
67
|
-
|
|
68
|
-
# same options as the installed command
|
|
67
|
+
# run from source; same options as the installed command
|
|
69
68
|
npm run dev -- --dir ~/projects/my-app
|
|
70
|
-
```
|
|
71
69
|
|
|
72
|
-
|
|
70
|
+
# tests, typecheck, build into `dist/`
|
|
73
71
|
npm test
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
```bash
|
|
77
72
|
npm run typecheck
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
73
|
npm run build
|
|
82
74
|
```
|
|
83
75
|
|
|
84
|
-
Release:
|
|
76
|
+
Release: a GitHub release for the tag publishes the version to npm ([`publish.yml`](.github/workflows/publish.yml)).
|
|
85
77
|
|
|
86
78
|
```bash
|
|
87
|
-
#
|
|
88
|
-
VERSION=1.2.
|
|
79
|
+
# version to release; add its section to CHANGELOG.md first
|
|
80
|
+
VERSION=1.2.1
|
|
81
|
+
|
|
82
|
+
# bump package.json and package-lock.json, no Git commit or tag
|
|
83
|
+
npm version "$VERSION" --no-git-tag-version
|
|
84
|
+
|
|
85
|
+
# commit, tag and push
|
|
86
|
+
git add CHANGELOG.md package.json package-lock.json
|
|
87
|
+
git commit -m "Release v$VERSION"
|
|
88
|
+
git tag "v$VERSION"
|
|
89
|
+
git push origin main "v$VERSION"
|
|
90
|
+
|
|
91
|
+
# GitHub release with the version's CHANGELOG section as notes; CI publishes to npm
|
|
92
|
+
gh release create "v$VERSION" --title "v$VERSION" --notes "$(awk -v v="## $VERSION " '/^## [0-9]/{p=index($0, v)==1} p' CHANGELOG.md)"
|
|
89
93
|
```
|