fork-version 1.4.67 → 1.4.69
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/CHANGELOG.md +16 -0
- package/README.md +57 -12
- package/package.json +11 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Fork Version
|
|
2
2
|
|
|
3
|
+
## 1.4.69 (2024-05-01)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Docs
|
|
7
|
+
|
|
8
|
+
* update text centring in readme ([a8919ef](https://github.com/eglavin/fork-version/commit/a8919ef3f27ad7042d17c68591a224d023f273bf))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## 1.4.68 (2024-05-01)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Docs
|
|
15
|
+
|
|
16
|
+
* update project description + update readme with more info ([37e7171](https://github.com/eglavin/fork-version/commit/37e7171c0fbdc6c77357d17e97c6249180c766b7))
|
|
17
|
+
|
|
18
|
+
|
|
3
19
|
## 1.4.67 (2024-04-28)
|
|
4
20
|
|
|
5
21
|
|
package/README.md
CHANGED
|
@@ -1,25 +1,70 @@
|
|
|
1
1
|
# Fork-Version
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/fork-version)
|
|
4
4
|
[](https://github.com/eglavin/fork-version/actions/workflows/version.yml)
|
|
5
5
|
[](https://github.com/eglavin/fork-version/actions/workflows/release.yml)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
<img src="assets/fork-version-logo.svg" alt="Fork Version Icon" width="200px">
|
|
9
|
+
</p>
|
|
8
10
|
|
|
9
|
-
<
|
|
11
|
+
<p align="center">
|
|
12
|
+
Fork-Version automates version control tasks such as determining, updating, and committing versions, files, and changelogs, simplifying the versioning process when adhering to the <a href="https://www.conventionalcommits.org">conventional commit</a> standard.
|
|
13
|
+
</p>
|
|
10
14
|
|
|
11
|
-
|
|
15
|
+
<details>
|
|
16
|
+
<summary>This project is essentially a complete re-write of standard-version following on from its deprecation in May 2022.</summary>
|
|
17
|
+
Although there are many alternatives such as <a href=https://github.com/googleapis/release-please>release-please</a>. This project aims to continue focusing on just the versioning and changelog generation aspect of the process for use in other Git hosts outside of Github.
|
|
18
|
+
</details>
|
|
12
19
|
|
|
13
|
-
|
|
20
|
+
## What Does Fork-Version Do?
|
|
21
|
+
|
|
22
|
+
By following the [conventional commit](https://www.conventionalcommits.org) standard Fork-Version can automate the following tasks for you:
|
|
23
|
+
|
|
24
|
+
1. Determine the current and next version
|
|
25
|
+
1. Update the version in the selected files
|
|
26
|
+
1. Update your changelog
|
|
27
|
+
1. Commit the changed files
|
|
28
|
+
1. Create a tag for the new version
|
|
29
|
+
|
|
30
|
+
## Using Fork-Version
|
|
31
|
+
|
|
32
|
+
Primarily designed to be used without installation with `npx`, Fork-Version can also be installed globally or directly to the node package you're working on. The only software prerequisites you need are [git](https://git-scm.com) and [node](https://nodejs.org).
|
|
14
33
|
|
|
15
|
-
|
|
16
|
-
| ------- | -------------------------------------------------- |
|
|
17
|
-
| npm | `npm install fork-version --save-exact --save-dev` |
|
|
18
|
-
| yarn | `yarn add fork-version --exact --dev` |
|
|
19
|
-
| pnpm | `pnpm add fork-version --save-exact --save-dev` |
|
|
34
|
+
### Using `npx` (Recommended)
|
|
20
35
|
|
|
21
|
-
|
|
36
|
+
By using `npx` you can use Fork-Version without installation, on more then just a node project.
|
|
22
37
|
|
|
23
|
-
|
|
38
|
+
#### Basic usage
|
|
39
|
+
|
|
40
|
+
To use Fork-Version with `npx` you can use the following command:
|
|
41
|
+
|
|
42
|
+
```sh
|
|
24
43
|
npx fork-version
|
|
25
44
|
```
|
|
45
|
+
|
|
46
|
+
`npx` is recommended as you will always being the latest version, otherwise you can use a version tag to use a specific version `npx fork-version@[tag]`. Example:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
npx fork-version@1.4.67
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Install Locally
|
|
53
|
+
|
|
54
|
+
To install the package locally to your project you can use one of the following commands:
|
|
55
|
+
|
|
56
|
+
| Package Manager | Install Command |
|
|
57
|
+
| --------------- | ------------------------------------- |
|
|
58
|
+
| npm | `npm install fork-version --save-dev` |
|
|
59
|
+
| yarn | `yarn add fork-version --dev` |
|
|
60
|
+
| pnpm | `pnpm add fork-version --save-dev` |
|
|
61
|
+
|
|
62
|
+
You can then add the following entry to your package.json scripts section and use it like the other scripts you already use in your project.
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"scripts": {
|
|
67
|
+
"release": "fork-version"
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
package/package.json
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fork-version",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.69",
|
|
4
4
|
"license": "ISC",
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "Fork-Version automates version control tasks such as determining, updating, and committing versions, files, and changelogs, simplifying the process when adhering to the conventional commit standard.",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"changelog",
|
|
8
|
+
"conventional changelog",
|
|
9
|
+
"conventional commits",
|
|
10
|
+
"git",
|
|
11
|
+
"semantic version",
|
|
12
|
+
"semver",
|
|
13
|
+
"version"
|
|
14
|
+
],
|
|
6
15
|
"homepage": "https://github.com/eglavin/fork-version",
|
|
7
16
|
"bugs": {
|
|
8
17
|
"url": "https://github.com/eglavin/fork-version/issues"
|