Add docs/Admin-API.md
[akkoma] / mix.exs
1 defmodule Pleroma.Mixfile do
2 use Mix.Project
3
4 def project do
5 [
6 app: :pleroma,
7 version: version("0.9.0"),
8 elixir: "~> 1.7",
9 elixirc_paths: elixirc_paths(Mix.env()),
10 compilers: [:phoenix, :gettext] ++ Mix.compilers(),
11 elixirc_options: [warnings_as_errors: true],
12 start_permanent: Mix.env() == :prod,
13 aliases: aliases(),
14 deps: deps(),
15
16 # Docs
17 name: "Pleroma",
18 source_url: "https://git.pleroma.social/pleroma/pleroma",
19 source_url_pattern:
20 "https://git.pleroma.social/pleroma/pleroma/blob/develop/%{path}#L%{line}",
21 homepage_url: "https://pleroma.social/",
22 docs: [
23 logo: "priv/static/static/logo.png",
24 extras: ["README.md", "docs/config.md", "docs/Pleroma-API.md", "docs/Admin-API.md"],
25 main: "readme",
26 output: "priv/static/doc"
27 ]
28 ]
29 end
30
31 # Configuration for the OTP application.
32 #
33 # Type `mix help compile.app` for more information.
34 def application do
35 [mod: {Pleroma.Application, []}, extra_applications: [:logger, :runtime_tools, :comeonin]]
36 end
37
38 # Specifies which paths to compile per environment.
39 defp elixirc_paths(:test), do: ["lib", "test/support"]
40 defp elixirc_paths(_), do: ["lib"]
41
42 # Specifies your project dependencies.
43 #
44 # Type `mix help deps` for examples and options.
45 defp deps do
46 [
47 # Until Phoenix 1.4.1 is released
48 {:phoenix, github: "phoenixframework/phoenix", branch: "v1.4"},
49 {:plug_cowboy, "~> 1.0"},
50 {:phoenix_pubsub, "~> 1.1"},
51 {:phoenix_ecto, "~> 3.3"},
52 {:postgrex, ">= 0.13.5"},
53 {:gettext, "~> 0.15"},
54 {:comeonin, "~> 4.1.1"},
55 {:pbkdf2_elixir, "~> 0.12.3"},
56 {:trailing_format_plug, "~> 0.0.7"},
57 {:html_sanitize_ex, "~> 1.3.0"},
58 {:phoenix_html, "~> 2.10"},
59 {:calendar, "~> 0.17.4"},
60 {:cachex, "~> 3.0.2"},
61 {:httpoison, "~> 1.2.0"},
62 {:tesla, "~> 1.2"},
63 {:jason, "~> 1.0"},
64 {:mogrify, "~> 0.6.1"},
65 {:ex_aws, "~> 2.0"},
66 {:ex_aws_s3, "~> 2.0"},
67 {:earmark, "~> 1.3"},
68 {:ex_machina, "~> 2.2", only: :test},
69 {:credo, "~> 0.9.3", only: [:dev, :test]},
70 {:mock, "~> 0.3.1", only: :test},
71 {:crypt,
72 git: "https://github.com/msantos/crypt", ref: "1f2b58927ab57e72910191a7ebaeff984382a1d3"},
73 {:cors_plug, "~> 1.5"},
74 {:ex_doc, "~> 0.19", only: :dev, runtime: false},
75 {:web_push_encryption, "~> 0.2.1"},
76 {:swoosh, "~> 0.20"},
77 {:gen_smtp, "~> 0.13"},
78 {:websocket_client, git: "https://github.com/jeremyong/websocket_client.git", only: :test}
79 ]
80 end
81
82 # Aliases are shortcuts or tasks specific to the current project.
83 # For example, to create, migrate and run the seeds file at once:
84 #
85 # $ mix ecto.setup
86 #
87 # See the documentation for `Mix` for more info on aliases.
88 defp aliases do
89 [
90 "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
91 "ecto.reset": ["ecto.drop", "ecto.setup"],
92 test: ["ecto.create --quiet", "ecto.migrate", "test"]
93 ]
94 end
95
96 # Builds a version string made of:
97 # * the application version
98 # * a pre-release if ahead of the tag: the describe string (-count-commithash)
99 # * build info:
100 # * a build name if `PLEROMA_BUILD_NAME` or `:pleroma, :build_name` is defined
101 # * the mix environment if different than prod
102 defp version(version) do
103 {git_tag, git_pre_release} =
104 with {tag, 0} <- System.cmd("git", ["describe", "--tags", "--abbrev=0"]),
105 tag = String.trim(tag),
106 {describe, 0} <- System.cmd("git", ["describe", "--tags", "--abbrev=8"]),
107 describe = String.trim(describe),
108 ahead <- String.replace(describe, tag, "") do
109 {String.replace_prefix(tag, "v", ""), if(ahead != "", do: String.trim(ahead))}
110 else
111 _ -> {nil, nil}
112 end
113
114 if git_tag && version != git_tag do
115 Mix.shell().error(
116 "Application version #{inspect(version)} does not match git tag #{inspect(git_tag)}"
117 )
118 end
119
120 build_name =
121 cond do
122 name = Application.get_env(:pleroma, :build_name) -> name
123 name = System.get_env("PLEROMA_BUILD_NAME") -> name
124 true -> nil
125 end
126
127 env_name = if Mix.env() != :prod, do: to_string(Mix.env())
128
129 build =
130 [build_name, env_name]
131 |> Enum.filter(fn string -> string && string != "" end)
132 |> Enum.join("-")
133 |> (fn
134 "" -> nil
135 string -> "+" <> string
136 end).()
137
138 [version, git_pre_release, build]
139 |> Enum.filter(fn string -> string && string != "" end)
140 |> Enum.join()
141 end
142 end