git-release-manager 0.0.0
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 +48 -0
- package/package.json +61 -0
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Git Release Notes Generator
|
|
2
|
+
|
|
3
|
+
A tool to generate release notes from git commit history.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Parse git commit history
|
|
8
|
+
- Generate structured release notes
|
|
9
|
+
- Customizable commit types and formats
|
|
10
|
+
- Support for mentions and links
|
|
11
|
+
- Flexible output formats
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm i -g git-release-manager
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
node src/main.js [options]
|
|
23
|
+
|
|
24
|
+
Options:
|
|
25
|
+
--from <tag> Starting tag
|
|
26
|
+
--to <tag> Ending tag
|
|
27
|
+
--tag <tag> Single tag
|
|
28
|
+
--output <path> Output file path
|
|
29
|
+
--config-file <path> Custom config file path
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Configuration
|
|
33
|
+
|
|
34
|
+
Create a custom config file to override default settings:
|
|
35
|
+
|
|
36
|
+
```javascript
|
|
37
|
+
module.exports = {
|
|
38
|
+
commitTypes: [
|
|
39
|
+
{ type: "feat", terms: ["feat", "feature"], title: "Features" }
|
|
40
|
+
],
|
|
41
|
+
linkTypes: [
|
|
42
|
+
{ type: "issue", terms: ["fixes", "resolves"], title: "Issues" }
|
|
43
|
+
],
|
|
44
|
+
mentionTypes: [
|
|
45
|
+
{ type: "reviewer", terms: ["reviewed-by"], title: "Reviewers" }
|
|
46
|
+
]
|
|
47
|
+
};
|
|
48
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "git-release-manager",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "A tool to generate release notes from git commit history",
|
|
5
|
+
"main": "index.ts",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"build": "tsc && npm run copy-config && npm run copy-template",
|
|
8
|
+
"start": "node dist/index.js changelog",
|
|
9
|
+
"changelog": "node dist/index.js changelog",
|
|
10
|
+
"dev": "tsc && node dist/index.js changelog",
|
|
11
|
+
"copy-config": "copyfiles -u 1 ./src/config/defaultConfig.*json ./dist/",
|
|
12
|
+
"copy-template": "copyfiles -u 1 ./src/templates/changelog.*ejs ./dist/",
|
|
13
|
+
"test": "jest"
|
|
14
|
+
},
|
|
15
|
+
"bin": {
|
|
16
|
+
"grm": "./dist/index.js"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist"
|
|
20
|
+
],
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"commander": "^13.0.0",
|
|
23
|
+
"ejs": "^3.1.10",
|
|
24
|
+
"minimist": "^1.2.8",
|
|
25
|
+
"simple-git": "^3.27.0"
|
|
26
|
+
},
|
|
27
|
+
"devDependencies": {
|
|
28
|
+
"@types/commander": "^2.12.2",
|
|
29
|
+
"@types/ejs": "^3.1.5",
|
|
30
|
+
"@types/jest": "^29.5.14",
|
|
31
|
+
"@types/minimist": "^1.2.5",
|
|
32
|
+
"@types/node": "^22.10.5",
|
|
33
|
+
"@typescript-eslint/eslint-plugin": "^6.19.0",
|
|
34
|
+
"@typescript-eslint/parser": "^6.19.0",
|
|
35
|
+
"copyfiles": "^2.4.1",
|
|
36
|
+
"eslint": "^8.0.0",
|
|
37
|
+
"jest": "^29.7.0",
|
|
38
|
+
"prettier": "^3.0.0",
|
|
39
|
+
"rimraf": "^5.0.5",
|
|
40
|
+
"ts-jest": "^29.2.5",
|
|
41
|
+
"ts-node": "^10.9.2",
|
|
42
|
+
"ts-node-dev": "^2.0.0",
|
|
43
|
+
"typescript": "^5.7.3"
|
|
44
|
+
},
|
|
45
|
+
"keywords": [
|
|
46
|
+
"git",
|
|
47
|
+
"release",
|
|
48
|
+
"changelog",
|
|
49
|
+
"release-notes",
|
|
50
|
+
"cli"
|
|
51
|
+
],
|
|
52
|
+
"author": "Ahmet Soner",
|
|
53
|
+
"license": "MIT",
|
|
54
|
+
"engines": {
|
|
55
|
+
"node": ">=14.0.0"
|
|
56
|
+
},
|
|
57
|
+
"repository": {
|
|
58
|
+
"type": "git",
|
|
59
|
+
"url": "https://github.com/ahmettsoner/changelog.git"
|
|
60
|
+
}
|
|
61
|
+
}
|