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.5.0"),
   8       elixir: "~> 1.12",
   9       elixirc_paths: elixirc_paths(Mix.env()),
  10       compilers: [:phoenix] ++ 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         :fast_sanitize,
  80         :os_mon,
  81         :ssl
  82       ],
  83       included_applications: [:ex_syslogger]
  84     ]
  85   end
  86
  87   # Specifies which paths to compile per environment.
  88   defp elixirc_paths(:benchmark), do: ["lib", "benchmarks", "priv/scrubbers"]
  89   defp elixirc_paths(:test), do: ["lib", "test/support"]
  90   defp elixirc_paths(_), do: ["lib"]
  91
  92   defp warnings_as_errors, do: System.get_env("CI") == "true"
  93
  94   # Specifies OAuth dependencies.
  95   defp oauth_deps do
  96     oauth_strategy_packages =
  97       "OAUTH_CONSUMER_STRATEGIES"
  98       |> System.get_env()
  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.15"},
 118       {:tzdata, "~> 1.1.1"},
 119       {:plug_cowboy, "~> 2.6"},
 120       {:phoenix_pubsub, "~> 2.1"},
 121       {:phoenix_ecto, "~> 4.4"},
 122       {:inet_cidr, "~> 1.0.0"},
 123       {:ecto_enum, "~> 1.4"},
 124       {:ecto_sql, "~> 3.9.0"},
 125       {:postgrex, ">= 0.16.3"},
 126       {:oban, "~> 2.12.1"},
 127       {:gettext, "~> 0.20.0"},
 128       {:bcrypt_elixir, "~> 2.2"},
 129       {:fast_sanitize, "~> 0.2.3"},
 130       {:html_entities, "~> 0.5"},
 131       {:phoenix_html, "~> 3.2"},
 132       {:calendar, "~> 1.0"},
 133       {:cachex, "~> 3.4"},
 134       {:tesla, "~> 1.4.4"},
 135       {:castore, "~> 0.1"},
 136       {:cowlib, "~> 2.9"},
 137       {:finch, "~> 0.14.0"},
 138       {:jason, "~> 1.2"},
 139       {:trailing_format_plug, "~> 0.0.7"},
 140       {:mogrify, "~> 0.9.1"},
 141       {:ex_aws, "~> 2.1.6"},
 142       {:ex_aws_s3, "~> 2.0"},
 143       {:sweet_xml, "~> 0.7.2"},
 144       {:earmark, "~> 1.4.15"},
 145       {:bbcode_pleroma, "~> 0.2.0"},
 146       {:crypt,
 147        git: "https://github.com/msantos/crypt.git",
 148        ref: "f75cd55325e33cbea198fb41fe41871392f8fb76"},
 149       {:cors_plug, "~> 2.0"},
 150       {:web_push_encryption, "~> 0.3.1"},
 151       {:swoosh, "~> 1.0"},
 152       # for gmail adapter in swoosh
 153       {:mail, ">= 0.0.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://akkoma.dev/AkkomaGang/linkify.git", branch: "bugfix/line-ending-buffer"},
 162       {:http_signatures, "~> 0.1.1"},
 163       {:telemetry, "~> 0.3"},
 164       {:telemetry_poller, "~> 0.4"},
 165       {:telemetry_metrics, "~> 0.4"},
 166       {:telemetry_metrics_prometheus_core, "~> 1.1.0"},
 167       {:poolboy, "~> 1.5"},
 168       {:recon, "~> 2.5"},
 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, "~> 1.1.0"},
 177       {:captcha,
 178        git: "https://git.pleroma.social/pleroma/elixir-libraries/elixir-captcha.git",
 179        ref: "e0f16822d578866e186a0974d65ad58cddc1e2ab"},
 180       {:restarter, path: "./restarter"},
 181       {:majic, "~> 1.0"},
 182       {:eblurhash, "~> 1.2.2"},
 183       {:open_api_spex, "~> 3.16.0"},
 184       {:search_parser,
 185        git: "https://github.com/FloatingGhost/pleroma-contrib-search-parser.git",
 186        ref: "08971a81e68686f9ac465cfb6661d51c5e4e1e7f"},
 187       {:nimble_parsec, "~> 1.0", override: true},
 188       {:phoenix_live_dashboard, "~> 0.7.2"},
 189       {:ecto_psql_extras, "~> 0.6"},
 190       {:elasticsearch,
 191        git: "https://akkoma.dev/AkkomaGang/elasticsearch-elixir.git", ref: "main"},
 192       {:mfm_parser,
 193        git: "https://akkoma.dev/AkkomaGang/mfm-parser.git",
 194        ref: "912fba81152d4d572e457fd5427f9875b2bc3dbe"},
 195       {:poison, ">= 0.0.0"},
 196
 197       ## dev & test
 198       {:ex_doc, "~> 0.22", only: :dev, runtime: false},
 199       {:ex_machina, "~> 2.4", only: :test},
 200       {:credo,
 201        git: "https://github.com/rrrene/credo.git",
 202        ref: "1c1b99ea41a457761383d81aaf6a606913996fe7",
 203        only: [:dev, :test],
 204        runtime: false},
 205       {:mock, "~> 0.3.5", only: :test},
 206       {:excoveralls, "0.15.1", only: :test},
 207       {:mox, "~> 1.0", only: :test},
 208       {:websockex, "~> 0.4.3", only: :test},
 209       {:dialyxir, "~> 1.0", only: [:dev], runtime: false}
 210     ] ++ oauth_deps()
 211   end
 212
 213   # Aliases are shortcuts or tasks specific to the current project.
 214   # For example, to create, migrate and run the seeds file at once:
 215   #
 216   #     $ mix ecto.setup
 217   #
 218   # See the documentation for `Mix` for more info on aliases.
 219   defp aliases do
 220     [
 221       "ecto.migrate": ["pleroma.ecto.migrate"],
 222       "ecto.rollback": ["pleroma.ecto.rollback"],
 223       "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
 224       "ecto.reset": ["ecto.drop", "ecto.setup"],
 225       test: ["ecto.create --quiet", "ecto.migrate", "test"],
 226       docs: ["pleroma.docs", "docs"],
 227       analyze: ["credo --strict --only=warnings,todo,fixme,consistency,readability"],
 228       copyright: &add_copyright/1,
 229       "copyright.bump": &bump_copyright/1
 230     ]
 231   end
 232
 233   # Builds a version string made of:
 234   # * the application version
 235   # * a pre-release if ahead of the tag: the describe string (-count-commithash)
 236   # * branch name
 237   # * build metadata:
 238   #   * a build name if `PLEROMA_BUILD_NAME` or `:pleroma, :build_name` is defined
 239   #   * the mix environment if different than prod
 240   defp version(version) do
 241     identifier_filter = ~r/[^0-9a-z\-]+/i
 242
 243     git_available? = match?({_output, 0}, System.cmd("sh", ["-c", "command -v git"]))
 244     dotgit_present? = File.exists?(".git")
 245
 246     git_pre_release =
 247       if git_available? and dotgit_present? do
 248         {tag, tag_err} =
 249           System.cmd("git", ["describe", "--tags", "--abbrev=0"], stderr_to_stdout: true)
 250
 251         {describe, describe_err} = System.cmd("git", ["describe", "--tags", "--abbrev=8"])
 252         {commit_hash, commit_hash_err} = System.cmd("git", ["rev-parse", "--short", "HEAD"])
 253
 254         # Pre-release version, denoted from patch version with a hyphen
 255         cond do
 256           tag_err == 0 and describe_err == 0 ->
 257             describe
 258             |> String.trim()
 259             |> String.replace(String.trim(tag), "")
 260             |> String.trim_leading("-")
 261             |> String.trim()
 262
 263           commit_hash_err == 0 ->
 264             "0-g" <> String.trim(commit_hash)
 265
 266           true ->
 267             nil
 268         end
 269       end
 270
 271     # Branch name as pre-release version component, denoted with a dot
 272     branch_name =
 273       with true <- git_available?,
 274            true <- dotgit_present?,
 275            {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
 276            branch_name <- String.trim(branch_name),
 277            branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
 278            true <-
 279              !Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
 280                String.starts_with?(name, branch_name)
 281              end) do
 282         branch_name =
 283           branch_name
 284           |> String.trim()
 285           |> String.replace(identifier_filter, "-")
 286
 287         branch_name
 288       else
 289         _ -> ""
 290       end
 291
 292     build_name =
 293       cond do
 294         name = Application.get_env(:pleroma, :build_name) -> name
 295         name = System.get_env("PLEROMA_BUILD_NAME") -> name
 296         true -> nil
 297       end
 298
 299     env_name = if Mix.env() != :prod, do: to_string(Mix.env())
 300     env_override = System.get_env("PLEROMA_BUILD_ENV")
 301
 302     env_name =
 303       case env_override do
 304         nil -> env_name
 305         env_override when env_override in ["", "prod"] -> nil
 306         env_override -> env_override
 307       end
 308
 309     # Pre-release version, denoted by appending a hyphen
 310     # and a series of dot separated identifiers
 311     pre_release =
 312       [git_pre_release, branch_name]
 313       |> Enum.filter(fn string -> string && string != "" end)
 314       |> Enum.join(".")
 315       |> (fn
 316             "" -> nil
 317             string -> "-" <> String.replace(string, identifier_filter, "-")
 318           end).()
 319
 320     # Build metadata, denoted with a plus sign
 321     build_metadata =
 322       [build_name, env_name]
 323       |> Enum.filter(fn string -> string && string != "" end)
 324       |> Enum.join(".")
 325       |> (fn
 326             "" -> nil
 327             string -> "+" <> String.replace(string, identifier_filter, "-")
 328           end).()
 329
 330     [version, pre_release, build_metadata]
 331     |> Enum.filter(fn string -> string && string != "" end)
 332     |> Enum.join()
 333   end
 334
 335   defp add_copyright(_) do
 336     year = NaiveDateTime.utc_now().year
 337     template = ~s[\
 338 # Pleroma: A lightweight social networking server
 339 # Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
 340 # SPDX-License-Identifier: AGPL-3.0-only
 341 # Akkoma: Magically expressive social media
 342 # Copyright © 2022-#{year} Akkoma Authors <https://akkoma.dev/>
 343 # SPDX-License-Identifier: AGPL-3.0-only
 344
 345 ] |> String.replace("\n", "\\n")
 346
 347     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
 348     grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
 349     xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
 350
 351     :os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
 352   end
 353
 354   defp bump_copyright(_) do
 355     year = NaiveDateTime.utc_now().year
 356     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
 357
 358     xargs =
 359       "xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
 360
 361     :os.cmd(String.to_charlist("#{find} | #{xargs}"))
 362   end
 363 end