Merge pull request #106 from codacy/ls/add-custom-version

feat: add flag to skip prerelease creation

Author: CallMeLeopoldo

README.md

@@ -189,6 +189,7 @@ You can configure the action with various inputs, a list of which has been provi
 | dev-branch       | The name of the development branch                                                              | dev           |
 | minor-identifier | The string used to identify a minor release (wrap with '/' to match using a regular expression) | feature:      |
 | major-identifier | The string used to identify a major release (wrap with '/' to match using a regular expression) | breaking:     |
+| skip-prerelease  | When true, release-branch and dev-branch are effectively ignored                                | false         |
 | prefix           | The prefix used for the version name                                                            |               |
 | log-paths        | The paths used to calculate changes (comma-separated)                                           |               |
 

action.yml

@@ -25,6 +25,10 @@ inputs:
     description: 'The string or regex to identify a major release commit'
     required: true
     default: 'breaking:'
+  skip-prerelease:
+    description: 'Skip prerelease part of the version. When true, release-branch and dev-branch are effectively ignored'
+    required: true
+    default: 'false'
   prefix:
     description: 'The prefix to use in the version'
     required: false
@@ -63,6 +67,7 @@ runs:
             --dev-branch "${{ inputs.dev-branch }}" \
             --minor-identifier="${{ inputs.minor-identifier }}" \
             --major-identifier="${{ inputs.major-identifier }}" \
+            ${{ inputs.skip-prerelease == 'true' && '--skip-prerelease' || '' }} \
             --version-prefix "${{ inputs.prefix }}")
 
         echo "previous-version=$PREVIOUS_VERSION" >> $GITHUB_OUTPUT
@@ -77,6 +82,7 @@ runs:
             --dev-branch "${{ inputs.dev-branch }}" \
             --minor-identifier="${{ inputs.minor-identifier }}" \
             --major-identifier="${{ inputs.major-identifier }}" \
+            ${{ inputs.skip-prerelease == 'true' && '--skip-prerelease' || '' }} \
             --version-prefix "${{ inputs.prefix }}")
 
         echo "version=$VERSION" >> $GITHUB_OUTPUT

spec/git-version-spec.cr

@@ -98,6 +98,28 @@ describe GitVersion do
     end
   end
 
+    it "should skip prerelease component in the version number when configured" do
+      tmp = InTmp.new
+
+      begin
+        tmp.exec %(git init)
+        tmp.exec %(git checkout -b master)
+        tmp.exec %(git commit --no-gpg-sign --allow-empty -m "1")
+        tmp.exec %(git tag "1.0.0")
+
+        tmp.exec %(git checkout -b my-test.branch)
+        tmp.exec %(git commit --no-gpg-sign --allow-empty -m "2")
+
+        git = GitVersion::Git.new("dev", "master", "feature:", "breaking:", tmp.@tmpdir, "", "", true)
+
+        version = git.get_new_version
+
+        version.should eq("1.0.1")
+      ensure
+        tmp.cleanup
+      end
+    end
+
   it "should properly bump the version" do
     tmp = InTmp.new
 

src/git-version.cr

@@ -12,7 +12,7 @@ module GitVersion
 
   class Git
     def initialize(@dev_branch : String, @release_branch : String, @minor_identifier : String, @major_identifier : String,
-                   @folder = FileUtils.pwd, @prefix : String = "", @log_paths : String = "")
+                   @folder = FileUtils.pwd, @prefix : String = "", @log_paths : String = "", @skip_prerelease : Bool = false)
       @major_id_is_regex = false
       @minor_id_is_regex = false
       if match = /\/(.*)\//.match(@major_identifier)
@@ -195,32 +195,36 @@ module GitVersion
 
       cb = current_branch_or_tag
 
-      if cb == @release_branch
-        #
-      elsif cb == @dev_branch
-        prerelease = [DEV_BRANCH_SUFFIX, commits_distance(previous_tag), current_commit_hash()] of String | Int32
-        previous_version =
-          SemanticVersion.new(
-            previous_version.major,
-            previous_version.minor,
-            previous_version.patch,
-            SemanticVersion::Prerelease.new(prerelease),
-            nil
-          )
-      else
-        branch_sanitized_name = cb.downcase.gsub(/[^a-zA-Z0-9]/, "")[0,30]
-        prerelease = [branch_sanitized_name, commits_distance(previous_tag), current_commit_hash()] of String | Int32
-        previous_version =
-          SemanticVersion.new(
-            previous_version.major,
-            previous_version.minor,
-            previous_version.patch,
-            SemanticVersion::Prerelease.new(prerelease),
-            nil
-          )
-      end
+      if ! @skip_prerelease
+        cb = current_branch_or_tag
 
+        if cb == @release_branch
+          #
+          elsif cb == @dev_branch
+          prerelease = [DEV_BRANCH_SUFFIX, commits_distance(previous_tag), current_commit_hash()] of String | Int32
+          previous_version =
+            SemanticVersion.new(
+              previous_version.major,
+              previous_version.minor,
+              previous_version.patch,
+              SemanticVersion::Prerelease.new(prerelease),
+              nil
+            )
+        else
+          branch_sanitized_name = cb.downcase.gsub(/[^a-zA-Z0-9]/, "")[0,30]
+          prerelease = [branch_sanitized_name, commits_distance(previous_tag), current_commit_hash()] of String | Int32
+          previous_version =
+            SemanticVersion.new(
+              previous_version.major,
+              previous_version.minor,
+              previous_version.patch,
+              SemanticVersion::Prerelease.new(prerelease),
+              nil
+            )
+        end
+      end
       return add_prefix(previous_version.to_s)
     end
+
   end
 end

src/main.cr

@@ -9,6 +9,7 @@ dev_branch = "dev"
 release_branch = "master"
 minor_identifier = "feature:"
 major_identifier = "breaking:"
+skip_prerelease = false
 prefix = ""
 log_paths = ""
 
@@ -23,6 +24,7 @@ OptionParser.parse do |parser|
     "Specifies the string or regex to identify a minor release commit with") { |identifier| minor_identifier = identifier }
   parser.on("--major-identifier=IDENTIFIER",
     "Specifies the string or regex to identify a major release commit with") { |identifier| major_identifier = identifier }
+  parser.on("--skip-prerelease BRANCH", "Skip the prerelase part of the version") { skip_prerelease=true }
   parser.on("-p PREFIX", "--version-prefix=PREFIX", "Specifies a version prefix") { |p| prefix = p }
   parser.on("-l PATH", "--log-paths=PATH", "") { |path| log_paths = path }
   parser.on("--previous-version", "Returns the previous tag instead of calculating a new one") { previous_version=true }
@@ -34,7 +36,7 @@ OptionParser.parse do |parser|
   end
 end
 
-git = GitVersion::Git.new(dev_branch, release_branch, minor_identifier, major_identifier, folder, prefix, log_paths)
+git = GitVersion::Git.new(dev_branch, release_branch, minor_identifier, major_identifier, folder, prefix, log_paths, skip_prerelease)
 
 if previous_version
   puts "#{git.get_previous_version}"