conventional-recommended-bump 12.0.0 → 12.0.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.
Files changed (2) hide show
  1. package/README.md +5 -44
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -31,19 +31,6 @@
31
31
 
32
32
  Get a recommended version bump based on conventional commits.
33
33
 
34
- > Got the idea from https://github.com/conventional-changelog/conventional-changelog/pull/29
35
-
36
- <hr />
37
- <a href="#install">Install</a>
38
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
39
- <a href="#usage">Usage</a>
40
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
41
- <a href="#api">API</a>
42
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
43
- <a href="#cli">CLI</a>
44
- <br />
45
- <hr />
46
-
47
34
  ## Install
48
35
 
49
36
  ```bash
@@ -66,42 +53,16 @@ const recommendation = await bumper.bump()
66
53
  console.log(recommendation.releaseType) // 'major'
67
54
  ```
68
55
 
69
- ## API
70
-
71
- ### `new Bumper(cwdOrGitClient: string | ConventionalGitClient = process.cwd())`
72
-
73
- Create a new Bumper instance. `cwdOrGitClient` is the current working directory or a `ConventionalGitClient` instance.
74
-
75
- #### `bumper.tag(paramsOrTag: GetSemverTagsParams | string): this`
76
-
77
- Set params to get the last semver tag or set the tag directly.
78
-
79
- #### `bumper.commits(params: GetCommitsParams, parserOptions?: ParserStreamOptions): this`
80
-
81
- Set params to get the commits.
82
-
83
- #### `bumper.commits(commits: Iterable<Commit> | AsyncIterable<Commit>): this`
84
-
85
- Set the commits directly.
86
-
87
- #### `bumper.loadPreset(preset: PresetParams): this`
88
-
89
- Load and set necessary params from a preset.
90
-
91
- #### `generator.config(config: Preset | Promise<Preset>): this`
92
-
93
- Set the config directly.
94
-
95
- #### `bumper.bump(whatBump?: (commits: Commit[]) => Promise<BumperRecommendation | null | undefined>): Promise<BumperRecommendation>`
96
-
97
- Get a recommended version bump based on conventional commits. `whatBump` function is required if preset is not loaded.
98
-
99
- ## CLI
56
+ CLI is also available:
100
57
 
101
58
  ```sh
102
59
  conventional-recommended-bump --help
103
60
  ```
104
61
 
62
+ ## Documentation
63
+
64
+ For comprehensive guides, CLI options, and API reference, visit the [documentation website](https://conventional-changelog.js.org/version-bump/).
65
+
105
66
  ## License
106
67
 
107
68
  MIT © [Steve Mao](https://github.com/stevemao)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "conventional-recommended-bump",
3
3
  "type": "module",
4
- "version": "12.0.0",
4
+ "version": "12.0.1",
5
5
  "description": "Get a recommended version bump based on conventional commits.",
6
6
  "author": {
7
7
  "name": "Steve Mao",
@@ -9,7 +9,7 @@
9
9
  "url": "https://github.com/stevemao"
10
10
  },
11
11
  "license": "MIT",
12
- "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump#readme",
12
+ "homepage": "https://conventional-changelog.js.org/version-bump/",
13
13
  "repository": {
14
14
  "type": "git",
15
15
  "url": "https://github.com/conventional-changelog/conventional-changelog.git",
@@ -36,10 +36,10 @@
36
36
  ],
37
37
  "dependencies": {
38
38
  "meow": "^14.0.0",
39
- "@conventional-changelog/git-client": "^3.0.0",
40
- "conventional-changelog-preset-loader": "^6.0.0",
41
- "conventional-commits-filter": "^6.0.0",
42
- "conventional-commits-parser": "^7.0.0"
39
+ "@conventional-changelog/git-client": "^3.0.2",
40
+ "conventional-changelog-preset-loader": "^6.0.1",
41
+ "conventional-commits-filter": "^6.0.1",
42
+ "conventional-commits-parser": "^7.0.1"
43
43
  },
44
44
  "bin": {
45
45
  "conventional-recommended-bump": "./dist/cli/index.js"