Misc doc changes (#231)

List of changes:
- Mix format module config
- Use common source url
- Bump and ex_doc to latest version
- Add changelog to html doc
- Add missing date to changelog

Author: kianmeng

CHANGELOG.md

@@ -1,29 +1,29 @@
 # Changelog
 
-## v2.3.1
+## v2.3.1 (2020-11-25)
 
 * Enhancements
   * Add `:connection_listeners` to `DBConnection.start_link/2`
   * Allow connection `~> 1.0`
 
-## v2.3.0
+## v2.3.0 (2020-10-14)
 
 This release requires Elixir v1.7+.
 
 * Bug fixes
   * Fix deprecation warnings related to the use of `System.stacktrace()`
 
-## v2.2.2
+## v2.2.2 (2020-04-22)
 
 * Bug fixes
   * Make sure all idle connections in the pool are pinged on each idle interval
 
-## v2.2.1
+## v2.2.1 (2020-02-04)
 
 * Enhancements
   * Remove warnings
 
-## v2.2.0
+## v2.2.0 (2019-12-11)
 
 * Enhancements
   * Add `:idle_time` to `DBConnection.LogEntry`

mix.exs

@@ -1,39 +1,48 @@
 defmodule DBConnection.Mixfile do
   use Mix.Project
 
+  @source_url "https://github.com/elixir-ecto/db_connection"
   @pools [:connection_pool, :ownership]
   @version "2.3.1"
 
   def project do
-    [app: :db_connection,
-     version: @version,
-     elixir: "~> 1.7",
-     deps: deps(),
-     docs: docs(),
-     description: description(),
-     package: package(),
-     build_per_environment: false,
-     consolidate_protocols: false,
-     test_paths: test_paths(Mix.env()),
-     aliases: ["test.all": ["test", "test.pools"],
-               "test.pools": &test_pools/1],
-     preferred_cli_env: ["test.all": :test]]
+    [
+      app: :db_connection,
+      version: @version,
+      elixir: "~> 1.7",
+      deps: deps(),
+      docs: docs(),
+      description: description(),
+      package: package(),
+      build_per_environment: false,
+      consolidate_protocols: false,
+      test_paths: test_paths(Mix.env()),
+      aliases: ["test.all": ["test", "test.pools"], "test.pools": &test_pools/1],
+      preferred_cli_env: ["test.all": :test]
+    ]
   end
 
   def application do
-    [applications: [:logger, :connection],
-     mod: {DBConnection.App, []}]
+    [
+      applications: [:logger, :connection],
+      mod: {DBConnection.App, []}
+    ]
   end
 
   defp deps do
-    [{:connection, "~> 1.0"},
-     {:ex_doc, "~> 0.12", only: :dev}]
+    [
+      {:connection, "~> 1.0"},
+      {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
+    ]
   end
 
   defp docs do
-    [source_url: "https://github.com/elixir-ecto/db_connection",
-     source_ref: "v#{@version}",
-     main: DBConnection]
+    [
+      source_url: @source_url,
+      source_ref: "v#{@version}",
+      main: DBConnection,
+      extras: ["CHANGELOG.md"]
+    ]
   end
 
   defp description do
@@ -43,9 +52,11 @@ defmodule DBConnection.Mixfile do
   end
 
   defp package do
-    %{licenses: ["Apache-2.0"],
+    %{
+      licenses: ["Apache-2.0"],
       maintainers: ["James Fish"],
-      links: %{"Github" => "https://github.com/elixir-ecto/db_connection"}}
+      links: %{"GitHub" => @source_url}
+    }
   end
 
   defp test_paths(pool) when pool in @pools, do: ["integration_test/#{pool}"]
@@ -56,12 +67,15 @@ defmodule DBConnection.Mixfile do
   end
 
   defp env_run(env, args) do
-    args = if IO.ANSI.enabled?(), do: ["--color"|args], else: ["--no-color"|args]
+    args = if IO.ANSI.enabled?(), do: ["--color" | args], else: ["--no-color" | args]
 
-    IO.puts "==> Running tests for MIX_ENV=#{env} mix test"
-    {_, res} = System.cmd "mix", ["test"|args],
-                          into: IO.binstream(:stdio, :line),
-                          env: [{"MIX_ENV", to_string(env)}]
+    IO.puts("==> Running tests for MIX_ENV=#{env} mix test")
+
+    {_, res} =
+      System.cmd("mix", ["test" | args],
+        into: IO.binstream(:stdio, :line),
+        env: [{"MIX_ENV", to_string(env)}]
+      )
 
     if res > 0 do
       System.at_exit(fn _ -> exit({:shutdown, 1}) end)