version_info 0.4.0 → 0.5.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.
- data/README.md +15 -8
- data/lib/version_info/version_info.yml +1 -1
- metadata +2 -2
data/README.md
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
|
-
|
|
1
|
+
### Overview
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
VersionIinfo is a powerful and very lightweight gem to manage version data in your Ruby projects or other gems.
|
|
4
|
+
VersionIinfo can manage a serie of predefined segments to build your version tag with the tipical structure X.X.X.X.
|
|
5
|
+
The values are stored in a yaml file, and supports custom values. Also, rake tasks are avaiable to simplify yaml file
|
|
6
|
+
creation and updates.
|
|
7
|
+
|
|
8
|
+
Feel free to contact me about bugs/features
|
|
4
9
|
|
|
5
|
-
|
|
10
|
+
### Usage
|
|
6
11
|
|
|
7
12
|
|
|
8
13
|
Include VersionInfo in your main project module (or class):
|
|
@@ -37,14 +42,14 @@ for use as the "segments" of the version tag:
|
|
|
37
42
|
|
|
38
43
|
Usingh the previous version_info.yml:
|
|
39
44
|
|
|
40
|
-
puts MyProject::VERSION
|
|
45
|
+
puts MyProject::VERSION
|
|
41
46
|
|
|
42
47
|
=> 0.1.0
|
|
43
48
|
|
|
44
49
|
Also you can bump any segment. With the same sample:
|
|
45
50
|
|
|
46
51
|
MyProject::VERSION.bump(:major)
|
|
47
|
-
puts MyProject::VERSION
|
|
52
|
+
puts MyProject::VERSION
|
|
48
53
|
|
|
49
54
|
=> 1.0.0
|
|
50
55
|
|
|
@@ -61,9 +66,6 @@ And you get a few tasks within namespace vinfo:
|
|
|
61
66
|
|
|
62
67
|
rake -T
|
|
63
68
|
=>
|
|
64
|
-
rake build # Build version_info-0.4.0.gem into the pkg directory
|
|
65
|
-
rake install # Build and install version_info-0.4.0.gem into system gems
|
|
66
|
-
rake release # Create tag v0.4.0 and build and push version_info-0.4.0.gem to Rubygems
|
|
67
69
|
rake vinfo:build # Bumps version segment BUILD
|
|
68
70
|
rake vinfo:major # Bumps version segment MAJOR
|
|
69
71
|
rake vinfo:minor # Bumps version segment MINOR
|
|
@@ -71,3 +73,8 @@ And you get a few tasks within namespace vinfo:
|
|
|
71
73
|
rake vinfo:pre # Bumps version segment PRE
|
|
72
74
|
rake vinfo:show # Show current version tag and create version_info.yml if missing
|
|
73
75
|
|
|
76
|
+
### Install
|
|
77
|
+
|
|
78
|
+
gem install version_info
|
|
79
|
+
|
|
80
|
+
|