Merge pull request 'stable release' (#160) from develop into stable
[akkoma] / mix.exs
1 defmodule Pleroma.Mixfile do
2 use Mix.Project
3
4 def project do
5 [
6 app: :pleroma,
7 version: version("3.1.0"),
8 elixir: "~> 1.9",
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,
14 aliases: aliases(),
15 deps: deps(),
16 test_coverage: [tool: ExCoveralls],
17 preferred_cli_env: ["coveralls.html": :test],
18 # Docs
19 name: "Akkoma",
20 homepage_url: "https://akkoma.dev/",
21 source_url: "https://akkoma.dev/AkkomaGang/akkoma",
22 docs: [
23 source_url_pattern: "https://akkoma.dev/AkkomaGang/akkoma/blob/develop/%{path}#L%{line}",
24 logo: "priv/static/images/logo.png",
25 extras: ["README.md", "CHANGELOG.md"] ++ Path.wildcard("docs/**/*.md"),
26 groups_for_extras: [
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")
31 ],
32 main: "readme",
33 output: "priv/static/doc"
34 ],
35 releases: [
36 pleroma: [
37 include_executables_for: [:unix],
38 applications: [ex_syslogger: :load, syslog: :load, eldap: :transient],
39 steps: [:assemble, &put_otp_version/1, &copy_files/1, &copy_nginx_config/1],
40 config_providers: [{Pleroma.Config.ReleaseRuntimeProvider, []}]
41 ]
42 ]
43 ]
44 end
45
46 def put_otp_version(%{path: target_path} = release) do
47 File.write!(
48 Path.join([target_path, "OTP_VERSION"]),
49 Pleroma.OTPVersion.version()
50 )
51
52 release
53 end
54
55 def copy_files(%{path: target_path} = release) do
56 File.cp_r!("./rel/files", target_path)
57 release
58 end
59
60 def copy_nginx_config(%{path: target_path} = release) do
61 File.cp!(
62 "./installation/nginx/akkoma.nginx",
63 Path.join([target_path, "installation", "akkoma.nginx"])
64 )
65
66 release
67 end
68
69 # Configuration for the OTP application.
70 #
71 # Type `mix help compile.app` for more information.
72 def application do
73 [
74 mod: {Pleroma.Application, []},
75 extra_applications: [
76 :logger,
77 :runtime_tools,
78 :comeonin,
79 :quack,
80 :fast_sanitize,
81 :os_mon,
82 :ssl
83 ],
84 included_applications: [:ex_syslogger]
85 ]
86 end
87
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"]
92
93 defp warnings_as_errors, do: System.get_env("CI") == "true"
94
95 # Specifies OAuth dependencies.
96 defp oauth_deps do
97 oauth_strategy_packages =
98 System.get_env("OAUTH_CONSUMER_STRATEGIES")
99 |> to_string()
100 |> String.split()
101 |> Enum.map(fn strategy_entry ->
102 with [_strategy, dependency] <- String.split(strategy_entry, ":") do
103 dependency
104 else
105 [strategy] -> "ueberauth_#{strategy}"
106 end
107 end)
108
109 for s <- oauth_strategy_packages, do: {String.to_atom(s), ">= 0.0.0"}
110 end
111
112 # Specifies your project dependencies.
113 #
114 # Type `mix help deps` for examples and options.
115 defp deps do
116 [
117 {:phoenix, "~> 1.6.11"},
118 {:tzdata, "~> 1.1.1"},
119 {:plug_cowboy, "~> 2.5"},
120 {:phoenix_pubsub, "~> 2.1"},
121 {:phoenix_ecto, "~> 4.4"},
122 {:ecto_enum, "~> 1.4"},
123 {:ecto_sql, "~> 3.8.3"},
124 {:postgrex, ">= 0.16.3"},
125 {:oban, "~> 2.12.1"},
126 {:gettext,
127 git: "https://github.com/tusooa/gettext.git",
128 ref: "72fb2496b6c5280ed911bdc3756890e7f38a4808",
129 override: true},
130 {:bcrypt_elixir, "~> 2.2"},
131 {:trailing_format_plug, "~> 0.0.7"},
132 {:fast_sanitize, "~> 0.2.0"},
133 {:html_entities, "~> 0.5", override: true},
134 {:phoenix_html, "~> 3.1", override: true},
135 {:calendar, "~> 1.0"},
136 {:cachex, "~> 3.4"},
137 {:poison, "~> 3.0", override: true},
138 {:tesla, "~> 1.4.4", override: true},
139 {:castore, "~> 0.1"},
140 {:cowlib, "~> 2.9", override: true},
141 {:gun, "~> 2.0.0-rc.1", override: true},
142 {:finch, "~> 0.10.0"},
143 {:jason, "~> 1.2"},
144 {:mogrify, "~> 0.9.1"},
145 {:ex_aws, "~> 2.1.6"},
146 {:ex_aws_s3, "~> 2.0"},
147 {:sweet_xml, "~> 0.7.2"},
148 {:earmark, "~> 1.4.15"},
149 {:bbcode_pleroma, "~> 0.2.0"},
150 {:crypt,
151 git: "https://github.com/msantos/crypt.git",
152 ref: "f75cd55325e33cbea198fb41fe41871392f8fb76"},
153 {:cors_plug, "~> 2.0"},
154 {:web_push_encryption, "~> 0.3.1"},
155 {:swoosh, "~> 1.0"},
156 {:phoenix_swoosh, "~> 0.3"},
157 {:gen_smtp, "~> 0.13"},
158 {:ex_syslogger, "~> 1.4"},
159 {:floki, "~> 0.27"},
160 {:timex, "~> 3.6"},
161 {:ueberauth, "~> 0.4"},
162 {:linkify,
163 git: "https://akkoma.dev/AkkomaGang/linkify.git", branch: "bugfix/line-ending-buffer"},
164 {:http_signatures, "~> 0.1.1"},
165 {:telemetry, "~> 0.3"},
166 {:poolboy, "~> 1.5"},
167 {:recon, "~> 2.5"},
168 {:quack, "~> 0.1.1"},
169 {:joken, "~> 2.0"},
170 {:benchee, "~> 1.0"},
171 {:pot, "~> 1.0"},
172 {:ex_const, "~> 0.2"},
173 {:plug_static_index_html, "~> 1.0.0"},
174 {:flake_id, "~> 0.1.0"},
175 {:concurrent_limiter, "~> 0.1.1"},
176 {:remote_ip,
177 git: "https://git.pleroma.social/pleroma/remote_ip.git",
178 ref: "b647d0deecaa3acb140854fe4bda5b7e1dc6d1c8"},
179 {:captcha,
180 git: "https://git.pleroma.social/pleroma/elixir-libraries/elixir-captcha.git",
181 ref: "e0f16822d578866e186a0974d65ad58cddc1e2ab"},
182 {:restarter, path: "./restarter"},
183 {:majic, "~> 1.0"},
184 {:eblurhash, "~> 1.2.2"},
185 {:open_api_spex, "3.10.0"},
186 {:search_parser,
187 git: "https://github.com/FloatingGhost/pleroma-contrib-search-parser.git",
188 ref: "08971a81e68686f9ac465cfb6661d51c5e4e1e7f"},
189 {:nimble_parsec, "~> 1.0", override: true},
190 {:phoenix_live_dashboard, "~> 0.6.2"},
191 {:ecto_psql_extras, "~> 0.6"},
192 {:elasticsearch,
193 git: "https://akkoma.dev/AkkomaGang/elasticsearch-elixir.git", ref: "main"},
194
195 # indirect dependency version override
196 {:plug, "~> 1.10.4", override: true},
197
198 ## dev & test
199 {:ex_doc, "~> 0.22", only: :dev, runtime: false},
200 {:ex_machina, "~> 2.4", only: :test},
201 {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
202 {:mock, "~> 0.3.5", only: :test},
203 # temporary downgrade for excoveralls, hackney until hackney max_connections bug will be fixed
204 {:excoveralls, "0.12.3", only: :test},
205 {:mox, "~> 1.0", only: :test},
206 {:websocket_client, git: "https://github.com/jeremyong/websocket_client.git", only: :test}
207 ] ++ oauth_deps()
208 end
209
210 # Aliases are shortcuts or tasks specific to the current project.
211 # For example, to create, migrate and run the seeds file at once:
212 #
213 # $ mix ecto.setup
214 #
215 # See the documentation for `Mix` for more info on aliases.
216 defp aliases do
217 [
218 "ecto.migrate": ["pleroma.ecto.migrate"],
219 "ecto.rollback": ["pleroma.ecto.rollback"],
220 "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
221 "ecto.reset": ["ecto.drop", "ecto.setup"],
222 test: ["ecto.create --quiet", "ecto.migrate", "test"],
223 docs: ["pleroma.docs", "docs"],
224 analyze: ["credo --strict --only=warnings,todo,fixme,consistency,readability"],
225 copyright: &add_copyright/1,
226 "copyright.bump": &bump_copyright/1
227 ]
228 end
229
230 # Builds a version string made of:
231 # * the application version
232 # * a pre-release if ahead of the tag: the describe string (-count-commithash)
233 # * branch name
234 # * build metadata:
235 # * a build name if `PLEROMA_BUILD_NAME` or `:pleroma, :build_name` is defined
236 # * the mix environment if different than prod
237 defp version(version) do
238 identifier_filter = ~r/[^0-9a-z\-]+/i
239
240 git_available? = match?({_output, 0}, System.cmd("sh", ["-c", "command -v git"]))
241 dotgit_present? = File.exists?(".git")
242
243 git_pre_release =
244 if git_available? and dotgit_present? do
245 {tag, tag_err} =
246 System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true)
247
248 {describe, describe_err} = System.cmd("git", ["describe", "--tags", "--abbrev=8"])
249 {commit_hash, commit_hash_err} = System.cmd("git", ["rev-parse", "--short", "HEAD"])
250
251 # Pre-release version, denoted from patch version with a hyphen
252 cond do
253 tag_err == 0 and describe_err == 0 ->
254 describe
255 |> String.trim()
256 |> String.replace(String.trim(tag), "")
257 |> String.trim_leading("-")
258 |> String.trim()
259
260 commit_hash_err == 0 ->
261 "0-g" <> String.trim(commit_hash)
262
263 true ->
264 nil
265 end
266 end
267
268 # Branch name as pre-release version component, denoted with a dot
269 branch_name =
270 with true <- git_available?,
271 true <- dotgit_present?,
272 {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
273 branch_name <- String.trim(branch_name),
274 branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
275 true <-
276 !Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
277 String.starts_with?(name, branch_name)
278 end) do
279 branch_name =
280 branch_name
281 |> String.trim()
282 |> String.replace(identifier_filter, "-")
283
284 branch_name
285 else
286 _ -> ""
287 end
288
289 build_name =
290 cond do
291 name = Application.get_env(:pleroma, :build_name) -> name
292 name = System.get_env("PLEROMA_BUILD_NAME") -> name
293 true -> nil
294 end
295
296 env_name = if Mix.env() != :prod, do: to_string(Mix.env())
297 env_override = System.get_env("PLEROMA_BUILD_ENV")
298
299 env_name =
300 case env_override do
301 nil -> env_name
302 env_override when env_override in ["", "prod"] -> nil
303 env_override -> env_override
304 end
305
306 # Pre-release version, denoted by appending a hyphen
307 # and a series of dot separated identifiers
308 pre_release =
309 [git_pre_release, branch_name]
310 |> Enum.filter(fn string -> string && string != "" end)
311 |> Enum.join(".")
312 |> (fn
313 "" -> nil
314 string -> "-" <> String.replace(string, identifier_filter, "-")
315 end).()
316
317 # Build metadata, denoted with a plus sign
318 build_metadata =
319 [build_name, env_name]
320 |> Enum.filter(fn string -> string && string != "" end)
321 |> Enum.join(".")
322 |> (fn
323 "" -> nil
324 string -> "+" <> String.replace(string, identifier_filter, "-")
325 end).()
326
327 [version, pre_release, build_metadata]
328 |> Enum.filter(fn string -> string && string != "" end)
329 |> Enum.join()
330 end
331
332 defp add_copyright(_) do
333 year = NaiveDateTime.utc_now().year
334 template = ~s[\
335 # Pleroma: A lightweight social networking server
336 # Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
337 # SPDX-License-Identifier: AGPL-3.0-only
338 # Akkoma: The cooler pleroma
339 # Copyright © 2022-#{year} Akkoma Authors <https://akkoma.dev/>
340 # SPDX-License-Identifier: AGPL-3.0-only
341
342 ] |> String.replace("\n", "\\n")
343
344 find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
345 grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
346 xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
347
348 :os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
349 end
350
351 defp bump_copyright(_) do
352 year = NaiveDateTime.utc_now().year
353 find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
354
355 xargs =
356 "xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
357
358 :os.cmd(String.to_charlist("#{find} | #{xargs}"))
359 end
360 end