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("3.0.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       {:prometheus, "~> 4.6"},
 168       {:prometheus_ex,
 169        git: "https://git.pleroma.social/pleroma/elixir-libraries/prometheus.ex.git",
 170        ref: "a4e9beb3c1c479d14b352fd9d6dd7b1f6d7deee5",
 171        override: true},
 172       {:prometheus_plugs, "~> 1.1"},
 173       {:prometheus_phoenix, "~> 1.3"},
 174       # Note: once `prometheus_phx` is integrated into `prometheus_phoenix`, remove the former:
 175       {:prometheus_phx,
 176        git: "https://git.pleroma.social/pleroma/elixir-libraries/prometheus-phx.git",
 177        branch: "no-logging"},
 178       {:prometheus_ecto, "~> 1.4"},
 179       {:recon, "~> 2.5"},
 180       {:quack, "~> 0.1.1"},
 181       {:joken, "~> 2.0"},
 182       {:benchee, "~> 1.0"},
 183       {:pot, "~> 1.0"},
 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.2.2"},
 197       {:open_api_spex, "3.10.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       {:elasticsearch,
 205        git: "https://akkoma.dev/AkkomaGang/elasticsearch-elixir.git", ref: "main"},
 206
 207       # indirect dependency version override
 208       {:plug, "~> 1.10.4", override: true},
 209
 210       ## dev & test
 211       {:ex_doc, "~> 0.22", only: :dev, runtime: false},
 212       {:ex_machina, "~> 2.4", only: :test},
 213       {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
 214       {:mock, "~> 0.3.5", only: :test},
 215       # temporary downgrade for excoveralls, hackney until hackney max_connections bug will be fixed
 216       {:excoveralls, "0.12.3", only: :test},
 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     dotgit_present? = File.exists?(".git")
 254
 255     git_pre_release =
 256       if git_available? and dotgit_present? do
 257         {tag, tag_err} =
 258           System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true)
 259
 260         {describe, describe_err} = System.cmd("git", ["describe", "--tags", "--abbrev=8"])
 261         {commit_hash, commit_hash_err} = System.cmd("git", ["rev-parse", "--short", "HEAD"])
 262
 263         # Pre-release version, denoted from patch version with a hyphen
 264         cond do
 265           tag_err == 0 and describe_err == 0 ->
 266             describe
 267             |> String.trim()
 268             |> String.replace(String.trim(tag), "")
 269             |> String.trim_leading("-")
 270             |> String.trim()
 271
 272           commit_hash_err == 0 ->
 273             "0-g" <> String.trim(commit_hash)
 274
 275           true ->
 276             nil
 277         end
 278       end
 279
 280     # Branch name as pre-release version component, denoted with a dot
 281     branch_name =
 282       with true <- git_available?,
 283            true <- dotgit_present?,
 284            {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
 285            branch_name <- String.trim(branch_name),
 286            branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
 287            true <-
 288              !Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
 289                String.starts_with?(name, branch_name)
 290              end) do
 291         branch_name =
 292           branch_name
 293           |> String.trim()
 294           |> String.replace(identifier_filter, "-")
 295
 296         branch_name
 297       else
 298         _ -> ""
 299       end
 300
 301     build_name =
 302       cond do
 303         name = Application.get_env(:pleroma, :build_name) -> name
 304         name = System.get_env("PLEROMA_BUILD_NAME") -> name
 305         true -> nil
 306       end
 307
 308     env_name = if Mix.env() != :prod, do: to_string(Mix.env())
 309     env_override = System.get_env("PLEROMA_BUILD_ENV")
 310
 311     env_name =
 312       case env_override do
 313         nil -> env_name
 314         env_override when env_override in ["", "prod"] -> nil
 315         env_override -> env_override
 316       end
 317
 318     # Pre-release version, denoted by appending a hyphen
 319     # and a series of dot separated identifiers
 320     pre_release =
 321       [git_pre_release, branch_name]
 322       |> Enum.filter(fn string -> string && string != "" end)
 323       |> Enum.join(".")
 324       |> (fn
 325             "" -> nil
 326             string -> "-" <> String.replace(string, identifier_filter, "-")
 327           end).()
 328
 329     # Build metadata, denoted with a plus sign
 330     build_metadata =
 331       [build_name, env_name]
 332       |> Enum.filter(fn string -> string && string != "" end)
 333       |> Enum.join(".")
 334       |> (fn
 335             "" -> nil
 336             string -> "+" <> String.replace(string, identifier_filter, "-")
 337           end).()
 338
 339     [version, pre_release, build_metadata]
 340     |> Enum.filter(fn string -> string && string != "" end)
 341     |> Enum.join()
 342   end
 343
 344   defp add_copyright(_) do
 345     year = NaiveDateTime.utc_now().year
 346     template = ~s[\
 347 # Pleroma: A lightweight social networking server
 348 # Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
 349 # SPDX-License-Identifier: AGPL-3.0-only
 350 # Akkoma: The cooler pleroma
 351 # Copyright © 2022-#{year} Akkoma Authors <https://akkoma.dev/>
 352 # SPDX-License-Identifier: AGPL-3.0-only
 353
 354 ] |> String.replace("\n", "\\n")
 355
 356     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
 357     grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
 358     xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
 359
 360     :os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
 361   end
 362
 363   defp bump_copyright(_) do
 364     year = NaiveDateTime.utc_now().year
 365     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
 366
 367     xargs =
 368       "xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
 369
 370     :os.cmd(String.to_charlist("#{find} | #{xargs}"))
 371   end
 372 end