Skip to content

Commit cb28036

Browse files
committed
Improve versionJson.md doc
Fixes #170
1 parent 669c282 commit cb28036

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

doc/versionJson.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
You must define a version.json file in your project directory or some ancestor of it.
44
It is common to define it in the root of your git repo.
5+
6+
**Important**: Some changes to version.json are not effective until you *commit* the change.
7+
Pushing your commit to a remote is not necessary.
8+
59
Here is the content of a sample version.json file you may start with:
610

711
```json
@@ -25,7 +29,10 @@ The content of the version.json file is a JSON serialized object with these prop
2529
```js
2630
{
2731
"version": "x.y-prerelease", // required (unless the "inherit" field is set to true and a parent version.json file sets this.)
28-
"assemblyVersion": "x.y", // optional. Use when x.y for AssemblyVersionAttribute differs from the default version property.
32+
"assemblyVersion": {
33+
"version": "x.y", // optional. Use when x.y for AssemblyVersionAttribute differs from the default version property.
34+
"precision": "revision" // optional. Use when you want a more precise assembly version than the default major.minor.
35+
},
2936
"versionHeightOffset": "zOffset", // optional. Use when you need to add/subtract a fixed value from the computed version height.
3037
"semVer1NumericIdentifierPadding": 4, // optional. Use when your -prerelease includes numeric identifiers and need semver1 support.
3138
"gitCommitIdShortFixedLength": 10, // optional. Set the commit ID abbreviation length.

0 commit comments

Comments
 (0)