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       start_permanent: Mix.env() == :prod,
  13       aliases: aliases(),
  14       deps: deps(),
  15       test_coverage: [tool: ExCoveralls],
  16       preferred_cli_env: ["coveralls.html": :test],
  17       # Docs
  18       name: "Akkoma",
  19       homepage_url: "https://akkoma.dev/",
  20       source_url: "https://akkoma.dev/AkkomaGang/akkoma",
  21       docs: [
  22         source_url_pattern: "https://akkoma.dev/AkkomaGang/akkoma/blob/develop/%{path}#L%{line}",
  23         logo: "priv/static/images/logo.png",
  24         extras: ["README.md", "CHANGELOG.md"] ++ Path.wildcard("docs/**/*.md"),
  25         groups_for_extras: [
  26           "Installation manuals": Path.wildcard("docs/installation/*.md"),
  27           Configuration: Path.wildcard("docs/config/*.md"),
  28           Administration: Path.wildcard("docs/admin/*.md"),
  29           "Pleroma's APIs and Mastodon API extensions": Path.wildcard("docs/api/*.md")
  30         ],
  31         main: "readme",
  32         output: "priv/static/doc"
  33       ],
  34       releases: [
  35         pleroma: [
  36           include_executables_for: [:unix],
  37           applications: [ex_syslogger: :load, syslog: :load],
  38           steps: [:assemble, &put_otp_version/1, &copy_files/1, &copy_nginx_config/1],
  39           config_providers: [{Pleroma.Config.ReleaseRuntimeProvider, []}]
  40         ]
  41       ]
  42     ]
  43   end
  44
  45   def put_otp_version(%{path: target_path} = release) do
  46     File.write!(
  47       Path.join([target_path, "OTP_VERSION"]),
  48       Pleroma.OTPVersion.version()
  49     )
  50
  51     release
  52   end
  53
  54   def copy_files(%{path: target_path} = release) do
  55     File.cp_r!("./rel/files", target_path)
  56     release
  57   end
  58
  59   def copy_nginx_config(%{path: target_path} = release) do
  60     File.cp!(
  61       "./installation/nginx/akkoma.nginx",
  62       Path.join([target_path, "installation", "akkoma.nginx"])
  63     )
  64
  65     release
  66   end
  67
  68   # Configuration for the OTP application.
  69   #
  70   # Type `mix help compile.app` for more information.
  71   def application do
  72     [
  73       mod: {Pleroma.Application, []},
  74       extra_applications: [
  75         :logger,
  76         :runtime_tools,
  77         :comeonin,
  78         :quack,
  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       System.get_env("OAUTH_CONSUMER_STRATEGIES")
  98       |> to_string()
  99       |> String.split()
 100       |> Enum.map(fn strategy_entry ->
 101         with [_strategy, dependency] <- String.split(strategy_entry, ":") do
 102           dependency
 103         else
 104           [strategy] -> "ueberauth_#{strategy}"
 105         end
 106       end)
 107
 108     for s <- oauth_strategy_packages, do: {String.to_atom(s), ">= 0.0.0"}
 109   end
 110
 111   # Specifies your project dependencies.
 112   #
 113   # Type `mix help deps` for examples and options.
 114   defp deps do
 115     [
 116       {:phoenix, "~> 1.6.11"},
 117       {:tzdata, "~> 1.1.1"},
 118       {:plug_cowboy, "~> 2.5"},
 119       {:phoenix_pubsub, "~> 2.1"},
 120       {:phoenix_ecto, "~> 4.4"},
 121       {:ecto_enum, "~> 1.4"},
 122       {:ecto_sql, "~> 3.8.3"},
 123       {:postgrex, ">= 0.16.3"},
 124       {:oban, "~> 2.12.1"},
 125       {:gettext,
 126        git: "https://github.com/tusooa/gettext.git",
 127        ref: "72fb2496b6c5280ed911bdc3756890e7f38a4808",
 128        override: true},
 129       {:bcrypt_elixir, "~> 2.2"},
 130       {:trailing_format_plug, "~> 0.0.7"},
 131       {:fast_sanitize, "~> 0.2.0"},
 132       {:html_entities, "~> 0.5", override: true},
 133       {:phoenix_html, "~> 3.1", override: true},
 134       {:calendar, "~> 1.0"},
 135       {:cachex, "~> 3.4"},
 136       {:poison, "~> 3.0", override: true},
 137       {:tesla, "~> 1.4.4", override: true},
 138       {:castore, "~> 0.1"},
 139       {:cowlib, "~> 2.9", override: true},
 140       {:gun, "~> 2.0.0-rc.1", override: true},
 141       {:finch, "~> 0.10.0"},
 142       {:jason, "~> 1.2"},
 143       {:mogrify, "~> 0.9.1"},
 144       {:ex_aws, "~> 2.1.6"},
 145       {:ex_aws_s3, "~> 2.0"},
 146       {:sweet_xml, "~> 0.7.2"},
 147       {:earmark, "~> 1.4.15"},
 148       {:bbcode_pleroma, "~> 0.2.0"},
 149       {:crypt,
 150        git: "https://github.com/msantos/crypt.git",
 151        ref: "f75cd55325e33cbea198fb41fe41871392f8fb76"},
 152       {:cors_plug, "~> 2.0"},
 153       {:web_push_encryption, "~> 0.3.1"},
 154       {:swoosh, "~> 1.0"},
 155       {:phoenix_swoosh, "~> 0.3"},
 156       {:gen_smtp, "~> 0.13"},
 157       {:ex_syslogger, "~> 1.4"},
 158       {:floki, "~> 0.27"},
 159       {:timex, "~> 3.6"},
 160       {:ueberauth, "~> 0.4"},
 161       {:linkify,
 162        git: "https://akkoma.dev/AkkomaGang/linkify.git", 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       {: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.2.2"},
 196       {:open_api_spex, "3.10.0"},
 197       {:search_parser,
 198        git: "https://github.com/FloatingGhost/pleroma-contrib-search-parser.git",
 199        ref: "08971a81e68686f9ac465cfb6661d51c5e4e1e7f"},
 200       {:nimble_parsec, "~> 1.0", override: true},
 201       {:phoenix_live_dashboard, "~> 0.6.2"},
 202       {:ecto_psql_extras, "~> 0.6"},
 203       {:elasticsearch,
 204        git: "https://akkoma.dev/AkkomaGang/elasticsearch-elixir.git", ref: "main"},
 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       {: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     dotgit_present? = File.exists?(".git")
 253
 254     git_pre_release =
 255       if git_available? and dotgit_present? 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            true <- dotgit_present?,
 283            {branch_name, 0} <- System.cmd("git", ["rev-parse", "--abbrev-ref", "HEAD"]),
 284            branch_name <- String.trim(branch_name),
 285            branch_name <- System.get_env("PLEROMA_BUILD_BRANCH") || branch_name,
 286            true <-
 287              !Enum.any?(["master", "HEAD", "release/", "stable"], fn name ->
 288                String.starts_with?(name, branch_name)
 289              end) do
 290         branch_name =
 291           branch_name
 292           |> String.trim()
 293           |> String.replace(identifier_filter, "-")
 294
 295         branch_name
 296       else
 297         _ -> ""
 298       end
 299
 300     build_name =
 301       cond do
 302         name = Application.get_env(:pleroma, :build_name) -> name
 303         name = System.get_env("PLEROMA_BUILD_NAME") -> name
 304         true -> nil
 305       end
 306
 307     env_name = if Mix.env() != :prod, do: to_string(Mix.env())
 308     env_override = System.get_env("PLEROMA_BUILD_ENV")
 309
 310     env_name =
 311       case env_override do
 312         nil -> env_name
 313         env_override when env_override in ["", "prod"] -> nil
 314         env_override -> env_override
 315       end
 316
 317     # Pre-release version, denoted by appending a hyphen
 318     # and a series of dot separated identifiers
 319     pre_release =
 320       [git_pre_release, branch_name]
 321       |> Enum.filter(fn string -> string && string != "" end)
 322       |> Enum.join(".")
 323       |> (fn
 324             "" -> nil
 325             string -> "-" <> String.replace(string, identifier_filter, "-")
 326           end).()
 327
 328     # Build metadata, denoted with a plus sign
 329     build_metadata =
 330       [build_name, env_name]
 331       |> Enum.filter(fn string -> string && string != "" end)
 332       |> Enum.join(".")
 333       |> (fn
 334             "" -> nil
 335             string -> "+" <> String.replace(string, identifier_filter, "-")
 336           end).()
 337
 338     [version, pre_release, build_metadata]
 339     |> Enum.filter(fn string -> string && string != "" end)
 340     |> Enum.join()
 341   end
 342
 343   defp add_copyright(_) do
 344     year = NaiveDateTime.utc_now().year
 345     template = ~s[\
 346 # Pleroma: A lightweight social networking server
 347 # Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>
 348 # SPDX-License-Identifier: AGPL-3.0-only
 349 # Akkoma: The cooler pleroma
 350 # Copyright © 2022-#{year} Akkoma Authors <https://akkoma.dev/>
 351 # SPDX-License-Identifier: AGPL-3.0-only
 352
 353 ] |> String.replace("\n", "\\n")
 354
 355     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\) -exec "
 356     grep = "grep -L '# Copyright © [0-9\-]* Pleroma' {} \\;"
 357     xargs = "xargs -n1 sed -i'' '1s;^;#{template};'"
 358
 359     :os.cmd(String.to_charlist("#{find}#{grep} | #{xargs}"))
 360   end
 361
 362   defp bump_copyright(_) do
 363     year = NaiveDateTime.utc_now().year
 364     find = "find lib test priv -type f \\( -name '*.ex' -or -name '*.exs' \\)"
 365
 366     xargs =
 367       "xargs sed -i'' 's;# Copyright © [0-9\-]* Pleroma.*$;# Copyright © 2017-#{year} Pleroma Authors <https://pleroma.social/>;'"
 368
 369     :os.cmd(String.to_charlist("#{find} | #{xargs}"))
 370   end
 371 end