git.squeep.com Git - akkoma/blob - mix.exs

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