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.5.1"),
   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/pleroma.nginx",
  63       Path.join([target_path, "installation", "pleroma.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.5.5"},
 118       {:tzdata, "~> 1.0.3"},
 119       {:plug_cowboy, "~> 2.3"},
 120       {:phoenix_pubsub, "~> 2.0"},
 121       {:phoenix_ecto, "~> 4.0"},
 122       {:ecto_enum, "~> 1.4"},
 123       {:ecto_sql, "~> 3.6.2"},
 124       {:postgrex, ">= 0.15.5"},
 125       {:oban, "~> 2.3.4"},
 126       {:gettext, "~> 0.18"},
 127       {:bcrypt_elixir, "~> 2.2"},
 128       {:trailing_format_plug, "~> 0.0.7"},
 129       {:fast_sanitize, "~> 0.2.0"},
 130       {:html_entities, "~> 0.5", override: true},
 131       {:phoenix_html, "~> 3.1", override: true},
 132       {:calendar, "~> 1.0"},
 133       {:cachex, "~> 3.2"},
 134       {:poison, "~> 3.0", override: true},
 135       {:tesla, "~> 1.4.4", override: true},
 136       {:castore, "~> 0.1"},
 137       {:cowlib, "~> 2.9", override: true},
 138       {:gun, "~> 2.0.0-rc.1", override: true},
 139       {:finch, "~> 0.10.0"},
 140       {:jason, "~> 1.2"},
 141       {:mogrify, "~> 0.9.1"},
 142       {:ex_aws, "~> 2.1.6"},
 143       {:ex_aws_s3, "~> 2.0"},
 144       {:sweet_xml, "~> 0.6.6"},
 145       {:earmark, "~> 1.4.15"},
 146       {:bbcode_pleroma, "~> 0.2.0"},
 147       {:crypt,
 148        git: "https://github.com/msantos/crypt.git",
 149        ref: "f75cd55325e33cbea198fb41fe41871392f8fb76"},
 150       {:cors_plug, "~> 2.0"},
 151       {:web_push_encryption, "~> 0.3.1"},
 152       {:swoosh, "~> 1.0"},
 153       {:phoenix_swoosh, "~> 0.3"},
 154       {:gen_smtp, "~> 0.13"},
 155       {:ex_syslogger, "~> 1.4"},
 156       {:floki, "~> 0.27"},
 157       {:timex, "~> 3.6"},
 158       {:ueberauth, "~> 0.4"},
 159       {:linkify,
 160        git: "https://git.ihatebeinga.live/floatingghost/linkify.git",
 161        branch: "bugfix/line-ending-buffer"},
 162       {:http_signatures, "~> 0.1.1"},
 163       {:telemetry, "~> 0.3"},
 164       {:poolboy, "~> 1.5"},
 165       {:prometheus, "~> 4.6"},
 166       {:prometheus_ex,
 167        git: "https://git.pleroma.social/pleroma/elixir-libraries/prometheus.ex.git",
 168        ref: "a4e9beb3c1c479d14b352fd9d6dd7b1f6d7deee5",
 169        override: true},
 170       {:prometheus_plugs, "~> 1.1"},
 171       {:prometheus_phoenix, "~> 1.3"},
 172       # Note: once `prometheus_phx` is integrated into `prometheus_phoenix`, remove the former:
 173       {:prometheus_phx,
 174        git: "https://git.pleroma.social/pleroma/elixir-libraries/prometheus-phx.git",
 175        branch: "no-logging"},
 176       {:prometheus_ecto, "~> 1.4"},
 177       {:recon, "~> 2.5"},
 178       {:quack, "~> 0.1.1"},
 179       {:joken, "~> 2.0"},
 180       {:benchee, "~> 1.0"},
 181       {:pot, "~> 1.0"},
 182       {:esshd, "~> 0.1.0", runtime: Application.get_env(:esshd, :enabled, false)},
 183       {:ex_const, "~> 0.2"},
 184       {:plug_static_index_html, "~> 1.0.0"},
 185       {:flake_id, "~> 0.1.0"},
 186       {:concurrent_limiter, "~> 0.1.1"},
 187       {:remote_ip,
 188        git: "https://git.pleroma.social/pleroma/remote_ip.git",
 189        ref: "b647d0deecaa3acb140854fe4bda5b7e1dc6d1c8"},
 190       {:captcha,
 191        git: "https://git.pleroma.social/pleroma/elixir-libraries/elixir-captcha.git",
 192        ref: "e0f16822d578866e186a0974d65ad58cddc1e2ab"},
 193       {:restarter, path: "./restarter"},
 194       {:majic, "~> 1.0"},
 195       {:eblurhash, "~> 1.1.0"},
 196       {:open_api_spex, "~> 3.10"},
 197       {:elastix, ">= 0.0.0"},
 198       {:search_parser,
 199        git: "https://github.com/FloatingGhost/pleroma-contrib-search-parser.git",
 200        ref: "08971a81e68686f9ac465cfb6661d51c5e4e1e7f"},
 201       {:nimble_parsec, "~> 1.0", override: true},
 202       {:phoenix_live_dashboard, "~> 0.6.2"},
 203       {:ecto_psql_extras, "~> 0.6"},
 204
 205       # indirect dependency version override
 206       {:plug, "~> 1.10.4", override: true},
 207
 208       ## dev & test
 209       {:ex_doc, "~> 0.22", only: :dev, runtime: false},
 210       {:ex_machina, "~> 2.4", only: :test},
 211       {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
 212       {:mock, "~> 0.3.5", only: :test},
 213       # temporary downgrade for excoveralls, hackney until hackney max_connections bug will be fixed
 214       {:excoveralls, "0.12.3", only: :test},
 215       {:hackney, "~> 1.18.0", override: true},
 216       {:mox, "~> 1.0", only: :test},
 217       {:websocket_client, git: "https://github.com/jeremyong/websocket_client.git", only: :test}
 218     ] ++ oauth_deps()
 219   end
 220
 221   # Aliases are shortcuts or tasks specific to the current project.
 222   # For example, to create, migrate and run the seeds file at once:
 223   #
 224   #     $ mix ecto.setup
 225   #
 226   # See the documentation for `Mix` for more info on aliases.
 227   defp aliases do
 228     [
 229       "ecto.migrate": ["pleroma.ecto.migrate"],
 230       "ecto.rollback": ["pleroma.ecto.rollback"],
 231       "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
 232       "ecto.reset": ["ecto.drop", "ecto.setup"],
 233       test: ["ecto.create --quiet", "ecto.migrate", "test"],
 234       docs: ["pleroma.docs", "docs"],
 235       analyze: ["credo --strict --only=warnings,todo,fixme,consistency,readability"],
 236       copyright: &add_copyright/1,
 237       "copyright.bump": &bump_copyright/1
 238     ]
 239   end
 240
 241   # Builds a version string made of:
 242   # * the application version
 243   # * a pre-release if ahead of the tag: the describe string (-count-commithash)
 244   # * branch name
 245   # * build metadata:
 246   #   * a build name if `PLEROMA_BUILD_NAME` or `:pleroma, :build_name` is defined
 247   #   * the mix environment if different than prod
 248   defp version(version) do
 249     identifier_filter = ~r/[^0-9a-z\-]+/i
 250
 251     git_available? = match?({_output, 0}, System.cmd("sh", ["-c", "command -v git"]))
 252
 253     git_pre_release =
 254       if git_available? do
 255         {tag, tag_err} =
 256           System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true)
 257
 258         {describe, describe_err} = System.cmd("git", ["describe", "--tags", "--abbrev=8"])
 259         {commit_hash, commit_hash_err} = System.cmd("git", ["rev-parse", "--short", "HEAD"])
 260
 261         # Pre-release version, denoted from patch version with a hyphen
 262         cond do
 263           tag_err == 0 and describe_err == 0 ->
 264             describe
 265             |> String.trim()
 266             |> String.replace(String.trim(tag), "")
 267             |> String.trim_leading("-")
 268             |> String.trim()
 269
 270           commit_hash_err == 0 ->
 271             "0-g" <> String.trim(commit_hash)
 272
 273           true ->
 274             nil
 275         end
 276       end
 277
 278     # Branch name as pre-release version component, denoted with a dot
 279     branch_name =
 280       with true <- git_available?,
 281            {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
 282            branch_name <- String.trim(branch_name),
 283            branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
 284            true <-
 285              !Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
 286                String.starts_with?(name, branch_name)
 287              end) do
 288         branch_name =
 289           branch_name
 290           |> String.trim()
 291           |> String.replace(identifier_filter, "-")
 292
 293         branch_name
 294       else
 295         _ -> ""
 296       end
 297
 298     build_name =
 299       cond do
 300         name = Application.get_env(:pleroma, :build_name) -> name
 301         name = System.get_env("PLEROMA_BUILD_NAME") -> name
 302         true -> nil
 303       end
 304
 305     env_name = if Mix.env() != :prod, do: to_string(Mix.env())
 306     env_override = System.get_env("PLEROMA_BUILD_ENV")
 307
 308     env_name =
 309       case env_override do
 310         nil -> env_name
 311         env_override when env_override in ["", "prod"] -> nil
 312         env_override -> env_override
 313       end
 314
 315     # Pre-release version, denoted by appending a hyphen
 316     # and a series of dot separated identifiers
 317     pre_release =
 318       [git_pre_release, branch_name]
 319       |> Enum.filter(fn string -> string && string != "" end)
 320       |> Enum.join(".")
 321       |> (fn
 322             "" -> nil
 323             string -> "-" <> String.replace(string, identifier_filter, "-")
 324           end).()
 325
 326     # Build metadata, denoted with a plus sign
 327     build_metadata =
 328       [build_name, env_name]
 329       |> Enum.filter(fn string -> string && string != "" end)
 330       |> Enum.join(".")
 331       |> (fn
 332             "" -> nil
 333             string -> "+" <> String.replace(string, identifier_filter, "-")
 334           end).()
 335
 336     [version, pre_release, build_metadata]
 337     |> Enum.filter(fn string -> string && string != "" end)
 338     |> Enum.join()
 339   end
 340
 341   defp add_copyright(_) do
 342     year = NaiveDateTime.utc_now().year
 343     template = ~s[\
 344 # Pleroma: A lightweight social networking server
 345 # Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
 346 # SPDX-License-Identifier: AGPL-3.0-only
 347
 348 ] |> String.replace("\n", "\\n")
 349
 350     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
 351     grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
 352     xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
 353
 354     :os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
 355   end
 356
 357   defp bump_copyright(_) do
 358     year = NaiveDateTime.utc_now().year
 359     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
 360
 361     xargs =
 362       "xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
 363
 364     :os.cmd(String.to_charlist("#{find} | #{xargs}"))
 365   end
 366 end