pleroma

commit: dcadf344719dcc0b0b09ae2cb97152ea67a3cec3
parent: a565dbde4f2262bf30ea2df50f08454f2edda900
Author: Haelwenn <contact+git.pleroma.social@hacktivis.me>
Date:   Wed,  3 Jul 2019 01:34:16 +0000

Merge branch '1048-semver-format-compliance' into 'develop'

Resolved violations of SemVer version format

Closes #1036 and #1048

See merge request pleroma/pleroma!1371
Diffstat:
M
mix.exs
48
+++++++++++++++++++++++++++---------------------
M
rel/files/bin/pleroma_ctl
5
++++-

2 files changed, 31 insertions(+), 22 deletions(-)
diff --git a/mix.exs b/mix.exs
@@ -174,10 +174,14 @@ defmodule Pleroma.Mixfile do
   # Builds a version string made of:
   # * the application version
   # * a pre-release if ahead of the tag: the describe string (-count-commithash)
-  # * build info:
+  # * branch name
+  # * build metadata:
   #   * a build name if `PLEROMA_BUILD_NAME` or `:pleroma, :build_name` is defined
   #   * the mix environment if different than prod
   defp version(version) do
+    identifier_filter = ~r/[^0-9a-z\-]+/i
+
+    # Pre-release version, denoted from patch version with a hyphen
     {git_tag, git_pre_release} =
       with {tag, 0} <-
              System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true),
@@ -198,6 +202,19 @@ defmodule Pleroma.Mixfile do
       )
     end
 
+    # Branch name as pre-release version component, denoted with a dot
+    branch_name =
+      with {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
+           branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
+           true <- branch_name != "master" do
+        branch_name =
+          branch_name
+          |> String.trim()
+          |> String.replace(identifier_filter, "-")
+
+        "." <> branch_name
+      end
+
     build_name =
       cond do
         name = Application.get_env(:pleroma, :build_name) -> name
@@ -206,37 +223,26 @@ defmodule Pleroma.Mixfile do
       end
 
     env_name = if Mix.env() != :prod, do: to_string(Mix.env())
-
     env_override = System.get_env("PLEROMA_BUILD_ENV")
 
     env_name =
-      if env_override do
-        if env_override != "prod", do: env_override
-      else
-        env_name
+      case env_override do
+        nil -> env_name
+        env_override when env_override in ["", "prod"] -> nil
+        env_override -> env_override
       end
 
-    build =
+    # Build metadata, denoted with a plus sign
+    build_metadata =
       [build_name, env_name]
       |> Enum.filter(fn string -> string && string != "" end)
-      |> Enum.join("-")
+      |> Enum.join(".")
       |> (fn
             "" -> nil
-            string -> "+" <> string
+            string -> "+" <> String.replace(string, identifier_filter, "-")
           end).()
 
-    branch_name =
-      with {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
-           branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
-           true <- branch_name != "master" do
-        branch_name =
-          String.trim(branch_name)
-          |> String.replace(~r/[^0-9a-z\-\.]+/i, "-")
-
-        "-" <> branch_name
-      end
-
-    [version, git_pre_release, branch_name, build]
+    [version, git_pre_release, branch_name, build_metadata]
     |> Enum.filter(fn string -> string && string != "" end)
     |> Enum.join()
   end
diff --git a/rel/files/bin/pleroma_ctl b/rel/files/bin/pleroma_ctl
@@ -30,12 +30,15 @@ detect_flavour() {
 
 detect_branch() {
 	version="$(cut -d' ' -f2 <"$RELEASE_ROOT"/releases/start_erl.data)"
-	branch="$(echo "$version" | cut -d'-' -f 4)"
+	# Expected format: major.minor.patch_version(-number_of_commits_ahead_of_tag-gcommit_hash).branch
+	branch="$(echo "$version" | cut -d'.' -f 4)"
 	if [ "$branch" = "develop" ]; then
 		echo "develop"
 	elif [ "$branch" = "" ]; then
 		echo "master"
 	else
+	  # Note: branch name in version is of SemVer format and may only contain [0-9a-zA-Z-] symbols —
+	  #   if supporting releases for more branches, need to ensure they contain only these symbols.
 		echo "Releases are built only for master and develop branches" >&2
 		exit 1
 	fi