pleroma/mix.exs

354 lines
11 KiB
Elixir
Raw Normal View History

2017-03-17 16:09:58 +00:00
defmodule Pleroma.Mixfile do
use Mix.Project
def project do
2018-03-30 13:01:53 +00:00
[
app: :pleroma,
version: version("2.6.51"),
elixir: "~> 1.11",
2018-03-30 13:01:53 +00:00
elixirc_paths: elixirc_paths(Mix.env()),
compilers: Mix.compilers(),
2021-06-23 19:19:26 +00:00
elixirc_options: [warnings_as_errors: warnings_as_errors()],
xref: [exclude: [:eldap]],
dialyzer: [plt_add_apps: [:mix, :eldap]],
2018-03-30 13:01:53 +00:00
start_permanent: Mix.env() == :prod,
aliases: aliases(),
2018-07-12 22:05:05 +00:00
deps: deps(),
test_coverage: [tool: :covertool, summary: true],
2018-07-12 22:05:05 +00:00
# Docs
name: "Pleroma",
homepage_url: "https://pleroma.social/",
2019-05-07 00:32:07 +00:00
source_url: "https://git.pleroma.social/pleroma/pleroma",
2018-07-12 22:05:05 +00:00
docs: [
2019-05-07 00:32:07 +00:00
source_url_pattern:
"https://git.pleroma.social/pleroma/pleroma/blob/develop/%{path}#L%{line}",
logo: "priv/static/images/logo.png",
2019-04-12 21:31:18 +00:00
extras: ["README.md", "CHANGELOG.md"] ++ Path.wildcard("docs/**/*.md"),
groups_for_extras: [
"Installation manuals": Path.wildcard("docs/installation/*.md"),
Configuration: Path.wildcard("docs/config/*.md"),
Administration: Path.wildcard("docs/admin/*.md"),
"Pleroma's APIs and Mastodon API extensions": Path.wildcard("docs/api/*.md")
2019-02-17 09:07:49 +00:00
],
main: "readme",
output: "priv/static/doc"
2019-06-08 14:17:10 +00:00
],
releases: [
pleroma: [
include_executables_for: [:unix],
applications: [ex_syslogger: :load, syslog: :load, eldap: :transient],
steps: [:assemble, &put_otp_version/1, &copy_files/1, &copy_nginx_config/1],
2021-04-08 12:45:31 +00:00
config_providers: [{Pleroma.Config.ReleaseRuntimeProvider, []}]
2019-06-08 14:17:10 +00:00
]
2018-07-12 22:05:05 +00:00
]
2018-03-30 13:01:53 +00:00
]
2017-03-17 16:09:58 +00:00
end
2020-04-09 23:19:41 +00:00
def put_otp_version(%{path: target_path} = release) do
File.write!(
Path.join([target_path, "OTP_VERSION"]),
Pleroma.OTPVersion.version()
)
release
end
def copy_files(%{path: target_path} = release) do
File.cp_r!("./rel/files", target_path)
2019-06-08 14:17:10 +00:00
release
end
def copy_nginx_config(%{path: target_path} = release) do
2019-06-21 02:57:46 +00:00
File.cp!(
"./installation/pleroma.nginx",
Path.join([target_path, "installation", "pleroma.nginx"])
)
release
end
2017-03-17 16:09:58 +00:00
# Configuration for the OTP application.
#
# Type `mix help compile.app` for more information.
def application do
2019-01-02 21:57:37 +00:00
[
mod: {Pleroma.Application, []},
extra_applications: [
:logger,
:runtime_tools,
:comeonin,
:fast_sanitize,
:os_mon,
:ssl
],
2019-01-02 21:57:37 +00:00
included_applications: [:ex_syslogger]
]
2017-03-17 16:09:58 +00:00
end
# Specifies which paths to compile per environment.
2021-12-03 21:20:54 +00:00
defp elixirc_paths(:benchmark), do: ["lib", "benchmarks", "priv/scrubbers"]
2017-03-17 16:09:58 +00:00
defp elixirc_paths(:test), do: ["lib", "test/support"]
2018-03-30 13:01:53 +00:00
defp elixirc_paths(_), do: ["lib"]
2017-03-17 16:09:58 +00:00
2021-06-23 19:19:26 +00:00
defp warnings_as_errors, do: System.get_env("CI") == "true"
# Specifies OAuth dependencies.
defp oauth_deps do
oauth_strategy_packages =
System.get_env("OAUTH_CONSUMER_STRATEGIES")
|> to_string()
|> String.split()
|> Enum.map(fn strategy_entry ->
with [_strategy, dependency] <- String.split(strategy_entry, ":") do
dependency
else
[strategy] -> "ueberauth_#{strategy}"
end
end)
for s <- oauth_strategy_packages, do: {String.to_atom(s), ">= 0.0.0"}
end
2017-03-17 16:09:58 +00:00
# Specifies your project dependencies.
#
# Type `mix help deps` for examples and options.
defp deps do
2018-03-30 13:01:53 +00:00
[
{:phoenix, "~> 1.7.3"},
{:phoenix_ecto, "~> 4.4"},
{:ecto_sql, "~> 3.10"},
{:ecto_enum, "~> 1.4"},
{:postgrex, ">= 0.0.0"},
{:phoenix_html, "~> 3.3"},
{:phoenix_live_reload, "~> 1.3.3", only: :dev},
{:phoenix_live_view, "~> 0.19.0"},
{:phoenix_live_dashboard, "~> 0.8.0"},
{:telemetry_metrics, "~> 0.6"},
{:telemetry_poller, "~> 1.0"},
{:tzdata, "~> 1.0.3"},
{:plug_cowboy, "~> 2.5"},
2023-04-04 08:56:19 +00:00
# oban 2.14 requires Elixir 1.12+
{:oban, "~> 2.13.4"},
{:gettext, "~> 0.20"},
2020-07-30 06:23:35 +00:00
{:bcrypt_elixir, "~> 2.2"},
2018-06-27 19:35:38 +00:00
{:trailing_format_plug, "~> 0.0.7"},
2020-08-07 13:45:04 +00:00
{:fast_sanitize, "~> 0.2.0"},
{:html_entities, "~> 0.5", override: true},
2020-07-30 05:58:19 +00:00
{:calendar, "~> 1.0"},
2020-02-29 17:40:23 +00:00
{:cachex, "~> 3.2"},
2019-03-11 17:37:26 +00:00
{:poison, "~> 3.0", override: true},
2020-11-17 12:09:56 +00:00
{:tesla, "~> 1.4.0", override: true},
2020-02-11 07:12:57 +00:00
{:castore, "~> 0.1"},
2020-07-29 03:55:44 +00:00
{:cowlib, "~> 2.9", override: true},
2021-05-15 11:08:00 +00:00
{:gun, "~> 2.0.0-rc.1", override: true},
{:finch, "~> 0.15"},
2020-07-29 04:13:59 +00:00
{:jason, "~> 1.2"},
{:mogrify, "~> 0.8.0"},
2020-11-16 19:51:44 +00:00
{:ex_aws, "~> 2.1.6"},
{:ex_aws_s3, "~> 2.0"},
2022-03-20 12:32:12 +00:00
{:sweet_xml, "~> 0.7.2"},
2023-04-04 08:56:19 +00:00
# earmark 1.4.23 requires Elixir 1.12+
{:earmark, "1.4.22"},
{:bbcode_pleroma, "~> 0.2.0"},
2020-07-30 06:12:42 +00:00
{:cors_plug, "~> 2.0"},
2022-01-02 04:02:09 +00:00
{:web_push_encryption, "~> 0.3.1"},
# swoosh 1.11.2+ requires Elixir 1.12+
{:swoosh, "~> 1.10.0"},
{:phoenix_swoosh, "~> 1.1"},
{:gen_smtp, "~> 0.13"},
{:ex_syslogger, "~> 1.4"},
{:floki, "~> 0.35"},
2020-07-29 03:55:44 +00:00
{:timex, "~> 3.6"},
2019-03-11 17:37:26 +00:00
{:ueberauth, "~> 0.4"},
2023-02-09 19:34:19 +00:00
{:linkify, "~> 0.5.3"},
2023-12-30 07:44:23 +00:00
{:http_signatures, "~> 0.1.2"},
{:telemetry, "~> 1.0.0", override: true},
{:poolboy, "~> 1.5"},
{:prom_ex, "~> 1.9"},
{:recon, "~> 2.5"},
2019-05-08 10:08:06 +00:00
{:joken, "~> 2.0"},
2021-05-22 16:04:13 +00:00
{:pot, "~> 1.0"},
2019-07-29 02:12:35 +00:00
{:ex_const, "~> 0.2"},
2019-05-15 15:19:20 +00:00
{:plug_static_index_html, "~> 1.0.0"},
{:flake_id, "~> 0.1.0"},
{:concurrent_limiter, "~> 0.1.1"},
2019-09-27 21:59:23 +00:00
{:remote_ip,
git: "https://git.pleroma.social/pleroma/remote_ip.git",
ref: "b647d0deecaa3acb140854fe4bda5b7e1dc6d1c8"},
{:captcha,
git: "https://git.pleroma.social/pleroma/elixir-libraries/elixir-captcha.git",
ref: "90f6ce7672f70f56708792a98d98bd05176c9176"},
2020-04-01 19:00:59 +00:00
{:restarter, path: "./restarter"},
{:majic, "~> 1.0"},
2023-01-15 22:28:32 +00:00
{:open_api_spex, "~> 3.16"},
{:ecto_psql_extras, "~> 0.6"},
2023-12-12 04:59:47 +00:00
{:vix, "~> 0.26.0"},
2023-11-07 21:31:35 +00:00
{:elixir_make, "~> 0.7.7", override: true},
{:blurhash, "~> 0.1.0", hex: :rinpatch_blurhash},
{:exile,
git: "https://git.pleroma.social/pleroma/elixir-libraries/exile.git",
2024-01-22 20:34:30 +00:00
ref: "0d6337cf68e7fbc8a093cae000955aa93b067f91"},
2020-07-29 03:45:08 +00:00
## dev & test
{:ex_doc, "~> 0.22", only: :dev, runtime: false},
{:ex_machina, "~> 2.4", only: :test},
{:credo, "~> 1.6", only: [:dev, :test], runtime: false},
2020-07-29 03:45:08 +00:00
{:mock, "~> 0.3.5", only: :test},
{:covertool, "~> 2.0", only: :test},
2021-11-29 17:28:10 +00:00
{:hackney, "~> 1.18.0", override: true},
{:mox, "~> 1.0", only: :test},
{:websockex, "~> 0.4.3", only: :test},
2024-01-21 03:49:37 +00:00
{:benchee, "~> 1.0", only: :benchmark},
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}
] ++ oauth_deps()
2017-03-17 16:09:58 +00:00
end
# Aliases are shortcuts or tasks specific to the current project.
# For example, to create, migrate and run the seeds file at once:
#
# $ mix ecto.setup
#
# See the documentation for `Mix` for more info on aliases.
defp aliases do
2018-03-30 13:01:53 +00:00
[
"ecto.migrate": ["pleroma.ecto.migrate"],
"ecto.rollback": ["pleroma.ecto.rollback"],
2018-03-30 13:01:53 +00:00
"ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
"ecto.reset": ["ecto.drop", "ecto.setup"],
test: ["ecto.create --quiet", "ecto.migrate", "test"],
docs: ["pleroma.docs", "docs"],
analyze: ["credo --strict --only=warnings,todo,fixme,consistency,readability"],
2021-01-15 23:26:02 +00:00
copyright: &add_copyright/1,
"copyright.bump": &bump_copyright/1
2018-03-30 13:01:53 +00:00
]
2017-03-17 16:09:58 +00:00
end
2018-11-20 16:55:03 +00:00
# Builds a version string made of:
# * the application version
# * a pre-release if ahead of the tag: the describe string (-count-commithash)
# * branch name
# * build metadata:
2018-11-20 16:55:03 +00:00
# * 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
git_available? = match?({_output, 0}, System.cmd("sh", ["-c", "command -v git"]))
2022-02-25 09:31:42 +00:00
dotgit_present? = File.exists?(".git")
2019-11-21 11:22:18 +00:00
git_pre_release =
2022-02-25 09:31:42 +00:00
if git_available? and dotgit_present? do
2020-04-23 21:44:03 +00:00
{tag, tag_err} =
System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true)
2020-04-23 21:44:03 +00:00
{describe, describe_err} = System.cmd("git", ["describe", "--tags", "--abbrev=8"])
{commit_hash, commit_hash_err} = System.cmd("git", ["rev-parse", "--short", "HEAD"])
2020-04-23 21:44:03 +00:00
# Pre-release version, denoted from patch version with a hyphen
cond do
tag_err == 0 and describe_err == 0 ->
describe
|> String.trim()
|> String.replace(String.trim(tag), "")
|> String.trim_leading("-")
|> String.trim()
commit_hash_err == 0 ->
"0-g" <> String.trim(commit_hash)
true ->
nil
2020-04-23 21:44:03 +00:00
end
2018-11-20 16:55:03 +00:00
end
# Branch name as pre-release version component, denoted with a dot
branch_name =
with true <- git_available?,
2022-02-25 09:31:42 +00:00
true <- dotgit_present?,
2020-04-23 21:44:03 +00:00
{branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
branch_name <- String.trim(branch_name),
branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
true <-
2019-10-14 19:13:18 +00:00
!Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
String.starts_with?(name, branch_name)
end) do
branch_name =
branch_name
|> String.trim()
|> String.replace(identifier_filter, "-")
branch_name
else
2020-04-23 21:44:30 +00:00
_ -> ""
end
2018-11-20 16:55:03 +00:00
build_name =
cond do
name = Application.get_env(:pleroma, :build_name) -> name
name = System.get_env("PLEROMA_BUILD_NAME") -> name
true -> nil
end
env_name = if Mix.env() != :prod, do: to_string(Mix.env())
env_override = System.get_env("PLEROMA_BUILD_ENV")
env_name =
case env_override do
nil -> env_name
env_override when env_override in ["", "prod"] -> nil
env_override -> env_override
end
# Pre-release version, denoted by appending a hyphen
# and a series of dot separated identifiers
pre_release =
[git_pre_release, branch_name]
|> Enum.filter(fn string -> string && string != "" end)
|> Enum.join(".")
|> (fn
"" -> nil
string -> "-" <> String.replace(string, identifier_filter, "-")
end).()
# Build metadata, denoted with a plus sign
build_metadata =
2018-11-20 16:55:03 +00:00
[build_name, env_name]
|> Enum.filter(fn string -> string && string != "" end)
|> Enum.join(".")
2018-11-20 16:55:03 +00:00
|> (fn
"" -> nil
string -> "+" <> String.replace(string, identifier_filter, "-")
2018-11-20 16:55:03 +00:00
end).()
[version, pre_release, build_metadata]
2018-11-20 16:55:03 +00:00
|> Enum.filter(fn string -> string && string != "" end)
|> Enum.join()
end
defp add_copyright(_) do
2021-01-15 23:25:43 +00:00
year = NaiveDateTime.utc_now().year
template = ~s[\
# Pleroma: A lightweight social networking server
# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
] |> String.replace("\n", "\\n")
find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
:os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
end
2021-01-15 23:26:02 +00:00
defp bump_copyright(_) do
year = NaiveDateTime.utc_now().year
find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
2021-01-15 23:26:02 +00:00
xargs =
"xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
2021-01-15 23:26:02 +00:00
:os.cmd(String.to_charlist("#{find} | #{xargs}"))
2021-01-15 23:26:02 +00:00
end
2017-03-17 16:09:58 +00:00
end