1 defmodule Pleroma.Mixfile do
7 version: version("2.5.4"),
9 elixirc_paths: elixirc_paths(Mix.env()),
10 compilers: [:phoenix, :gettext] ++ Mix.compilers(),
11 elixirc_options: [warnings_as_errors: warnings_as_errors()],
12 xref: [exclude: [:eldap]],
13 start_permanent: Mix.env() == :prod,
16 test_coverage: [tool: :covertool, summary: true],
19 homepage_url: "https://pleroma.social/",
20 source_url: "https://git.pleroma.social/pleroma/pleroma",
23 "https://git.pleroma.social/pleroma/pleroma/blob/develop/%{path}#L%{line}",
24 logo: "priv/static/images/logo.png",
25 extras: ["README.md", "CHANGELOG.md"] ++ Path.wildcard("docs/**/*.md"),
27 "Installation manuals": Path.wildcard("docs/installation/*.md"),
28 Configuration: Path.wildcard("docs/config/*.md"),
29 Administration: Path.wildcard("docs/admin/*.md"),
30 "Pleroma's APIs and Mastodon API extensions": Path.wildcard("docs/api/*.md")
33 output: "priv/static/doc"
37 include_executables_for: [:unix],
38 applications: [ex_syslogger: :load, syslog: :load, eldap: :transient],
39 steps: [:assemble, &put_otp_version/1, ©_files/1, ©_nginx_config/1],
40 config_providers: [{Pleroma.Config.ReleaseRuntimeProvider, []}]
46 def put_otp_version(%{path: target_path} = release) do
48 Path.join([target_path, "OTP_VERSION"]),
49 Pleroma.OTPVersion.version()
55 def copy_files(%{path: target_path} = release) do
56 File.cp_r!("./rel/files", target_path)
60 def copy_nginx_config(%{path: target_path} = release) do
62 "./installation/pleroma.nginx",
63 Path.join([target_path, "installation", "pleroma.nginx"])
69 # Configuration for the OTP application.
71 # Type `mix help compile.app` for more information.
74 mod: {Pleroma.Application, []},
84 included_applications: [:ex_syslogger]
88 # Specifies which paths to compile per environment.
89 defp elixirc_paths(:benchmark), do: ["lib", "benchmarks", "priv/scrubbers"]
90 defp elixirc_paths(:test), do: ["lib", "test/support"]
91 defp elixirc_paths(_), do: ["lib"]
93 defp warnings_as_errors, do: System.get_env("CI") == "true"
95 # Specifies OAuth dependencies.
97 oauth_strategy_packages =
98 System.get_env("OAUTH_CONSUMER_STRATEGIES")
101 |> Enum.map(fn strategy_entry ->
102 with [_strategy, dependency] <- String.split(strategy_entry, ":") do
105 [strategy] -> "ueberauth_#{strategy}"
109 for s <- oauth_strategy_packages, do: {String.to_atom(s), ">= 0.0.0"}
112 # Specifies your project dependencies.
114 # Type `mix help deps` for examples and options.
117 {:phoenix, "~> 1.6.0"},
118 {:phoenix_ecto, "~> 4.4.0"},
119 {:ecto_enum, "~> 1.4"},
120 {:postgrex, ">= 0.0.0"},
121 {:phoenix_html, "~> 3.1"},
122 {:phoenix_live_reload, "~> 1.3.3", only: :dev},
123 {:phoenix_live_view, "~> 0.17.1"},
124 {:phoenix_live_dashboard, "~> 0.6.2"},
125 {:telemetry_metrics, "~> 0.6.1"},
126 {:telemetry_poller, "~> 1.0"},
127 {:tzdata, "~> 1.0.3"},
128 {:plug_cowboy, "~> 2.3"},
131 git: "https://github.com/tusooa/gettext.git",
132 ref: "72fb2496b6c5280ed911bdc3756890e7f38a4808",
134 {:bcrypt_elixir, "~> 2.2"},
135 {:trailing_format_plug, "~> 0.0.7"},
136 {:fast_sanitize, "~> 0.2.0"},
137 {:html_entities, "~> 0.5", override: true},
138 {:calendar, "~> 1.0"},
140 {:poison, "~> 3.0", override: true},
141 {:tesla, "~> 1.4.0", override: true},
142 {:castore, "~> 0.1"},
143 {:cowlib, "~> 2.9", override: true},
144 {:gun, "~> 2.0.0-rc.1", override: true},
145 {:finch, "~> 0.10.0"},
147 {:mogrify, "~> 0.9.1"},
148 {:ex_aws, "~> 2.1.6"},
149 {:ex_aws_s3, "~> 2.0"},
150 {:sweet_xml, "~> 0.7.2"},
151 {:earmark, "~> 1.4.22"},
152 {:bbcode_pleroma, "~> 0.2.0"},
153 {:cors_plug, "~> 2.0"},
154 {:web_push_encryption, "~> 0.3.1"},
156 {:phoenix_swoosh, "~> 1.1"},
157 {:gen_smtp, "~> 0.13"},
158 {:ex_syslogger, "~> 1.4"},
161 {:ueberauth, "~> 0.4"},
163 git: "https://gitgud.io/mintplg/linkify.git",
164 branch: "domain-mention-parsing-fix"},
165 {:http_signatures, "~> 0.1.1"},
166 {:telemetry, "~> 1.0.0", override: true},
167 {:poolboy, "~> 1.5"},
168 {:prometheus, "~> 4.6"},
170 git: "https://github.com/lanodan/prometheus.ex.git",
171 branch: "fix/elixir-1.14",
173 {:prometheus_plugs, "~> 1.1"},
174 {:prometheus_phoenix, "~> 1.3"},
175 # Note: once `prometheus_phx` is integrated into `prometheus_phoenix`, remove the former:
177 git: "https://git.pleroma.social/pleroma/elixir-libraries/prometheus-phx.git",
178 branch: "no-logging"},
179 {:prometheus_ecto, "~> 1.4"},
182 {:benchee, "~> 1.0"},
184 {:esshd, "~> 0.1.0", runtime: Application.get_env(:esshd, :enabled, false)},
185 {:ex_const, "~> 0.2"},
186 {:plug_static_index_html, "~> 1.0.0"},
187 {:flake_id, "~> 0.1.0"},
188 {:concurrent_limiter, "~> 0.1.1"},
190 git: "https://git.pleroma.social/pleroma/remote_ip.git",
191 ref: "b647d0deecaa3acb140854fe4bda5b7e1dc6d1c8"},
193 git: "https://git.pleroma.social/pleroma/elixir-libraries/elixir-captcha.git",
194 ref: "e0f16822d578866e186a0974d65ad58cddc1e2ab"},
195 {:restarter, path: "./restarter"},
197 {:eblurhash, "~> 1.2.2"},
198 {:open_api_spex, "~> 3.10"},
199 {:ecto_psql_extras, "~> 0.6"},
201 # indirect dependency version override
202 {:plug, "~> 1.10.4", override: true},
205 {:ex_doc, "~> 0.22", only: :dev, runtime: false},
206 {:ex_machina, "~> 2.4", only: :test},
207 {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
208 {:mock, "~> 0.3.5", only: :test},
209 {:covertool, "~> 2.0", only: :test},
210 {:hackney, "~> 1.18.0", override: true},
211 {:mox, "~> 1.0", only: :test},
212 {:websockex, "~> 0.4.3", only: :test}
216 # Aliases are shortcuts or tasks specific to the current project.
217 # For example, to create, migrate and run the seeds file at once:
221 # See the documentation for `Mix` for more info on aliases.
224 "ecto.migrate": ["pleroma.ecto.migrate"],
225 "ecto.rollback": ["pleroma.ecto.rollback"],
226 "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
227 "ecto.reset": ["ecto.drop", "ecto.setup"],
228 test: ["ecto.create --quiet", "ecto.migrate", "test"],
229 docs: ["pleroma.docs", "docs"],
230 analyze: ["credo --strict --only=warnings,todo,fixme,consistency,readability"],
231 copyright: &add_copyright/1,
232 "copyright.bump": &bump_copyright/1
236 # Builds a version string made of:
237 # * the application version
238 # * a pre-release if ahead of the tag: the describe string (-count-commithash)
241 # * a build name if `PLEROMA_BUILD_NAME` or `:pleroma, :build_name` is defined
242 # * the mix environment if different than prod
243 defp version(version) do
244 identifier_filter = ~r/[^0-9a-z\-]+/i
246 git_available? = match?({_output, 0}, System.cmd("sh", ["-c", "command -v git"]))
247 dotgit_present? = File.exists?(".git")
250 if git_available? and dotgit_present? do
252 System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true)
254 {describe, describe_err} = System.cmd("git", ["describe", "--tags", "--abbrev=8"])
255 {commit_hash, commit_hash_err} = System.cmd("git", ["rev-parse", "--short", "HEAD"])
257 # Pre-release version, denoted from patch version with a hyphen
259 tag_err == 0 and describe_err == 0 ->
262 |> String.replace(String.trim(tag), "")
263 |> String.trim_leading("-")
266 commit_hash_err == 0 ->
267 "0-g" <> String.trim(commit_hash)
274 # Branch name as pre-release version component, denoted with a dot
276 with true <- git_available?,
277 true <- dotgit_present?,
278 {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
279 branch_name <- String.trim(branch_name),
280 branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
282 !Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
283 String.starts_with?(name, branch_name)
288 |> String.replace(identifier_filter, "-")
297 name = Application.get_env(:pleroma, :build_name) -> name
298 name = System.get_env("PLEROMA_BUILD_NAME") -> name
302 env_name = if Mix.env() != :prod, do: to_string(Mix.env())
303 env_override = System.get_env("PLEROMA_BUILD_ENV")
308 env_override when env_override in ["", "prod"] -> nil
309 env_override -> env_override
312 # Pre-release version, denoted by appending a hyphen
313 # and a series of dot separated identifiers
315 [git_pre_release, branch_name]
316 |> Enum.filter(fn string -> string && string != "" end)
320 string -> "-" <> String.replace(string, identifier_filter, "-")
323 # Build metadata, denoted with a plus sign
325 [build_name, env_name]
326 |> Enum.filter(fn string -> string && string != "" end)
330 string -> "+" <> String.replace(string, identifier_filter, "-")
333 [version, pre_release, build_metadata]
334 |> Enum.filter(fn string -> string && string != "" end)
338 defp add_copyright(_) do
339 year = NaiveDateTime.utc_now().year
341 # Pleroma: A lightweight social networking server
342 # Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
343 # SPDX-License-Identifier: AGPL-3.0-only
345 ] |> String.replace("\n", "\\n")
347 find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
348 grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
349 xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
351 :os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
354 defp bump_copyright(_) do
355 year = NaiveDateTime.utc_now().year
356 find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
359 "xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
361 :os.cmd(String.to_charlist("#{find} | #{xargs}"))