Merge branch '8-improve-ci' into 'master'

Improve CI

Closes #8.

- change image to `bitwalker/alpine-elixir:1.10.4`
- 5 stages, 2 sequences in parallel: 1 cache for dev, 1 for test
- 2 artifacts for reports
- 1 artifact for dialyzer PLT (cache as artifact so that it still caches on fail)

See merge request kazarma/matrix_app_service.ex!9

5 files changed, 21 insertions, 3 deletions

diff --git a/lib/matrix_app_service/application.ex b/lib/matrix_app_service/application.ex
index 408d5ab..df9acab 100644
--- a/lib/matrix_app_service/application.ex
+++ b/lib/matrix_app_service/application.ex
@@ -49,15 +49,15 @@ defmodule MatrixAppService.Application do
     :ok
   end
 
-  def start_endpoint?() do
+  def start_endpoint? do
     Application.get_env(:matrix_app_service, :internal_supervisor, false)
   end
 
-  def start_repo?() do
+  def start_repo? do
     Application.get_env(:matrix_app_service, :internal_repo, false)
   end
 
-  def endpoint_config() do
+  def endpoint_config do
     [
       transaction_adapter: Application.fetch_env!(:matrix_app_service, :transaction_adapter),
       room_adapter: Application.fetch_env!(:matrix_app_service, :room_adapter),
diff --git a/lib/matrix_app_service/bridge.ex b/lib/matrix_app_service/bridge.ex
index e0e0fee..42f3450 100644
--- a/lib/matrix_app_service/bridge.ex
+++ b/lib/matrix_app_service/bridge.ex
@@ -1,3 +1,7 @@
 defmodule MatrixAppService.Bridge do
+  @moduledoc """
+  This module is used when the library uses its own repo. 
+  """
+
   use MatrixAppService.BridgeConfig, repo: MatrixAppService.Repo
 end
diff --git a/lib/matrix_app_service/bridge/room.ex b/lib/matrix_app_service/bridge/room.ex
index 73ef1ea..e8613a1 100644
--- a/lib/matrix_app_service/bridge/room.ex
+++ b/lib/matrix_app_service/bridge/room.ex
@@ -1,4 +1,8 @@
 defmodule MatrixAppService.Bridge.Room do
+  @moduledoc """
+  Schema and helpers for keeping track of room correspondence. 
+  """
+
   use Ecto.Schema
   import Ecto.Changeset
 
diff --git a/lib/matrix_app_service/bridge/user.ex b/lib/matrix_app_service/bridge/user.ex
index 7bf604a..93cafbf 100644
--- a/lib/matrix_app_service/bridge/user.ex
+++ b/lib/matrix_app_service/bridge/user.ex
@@ -1,4 +1,8 @@
 defmodule MatrixAppService.Bridge.User do
+  @moduledoc """
+  Schema and helpers for keeping track of user correspondence. 
+  """
+
   use Ecto.Schema
   import Ecto.Changeset
 
diff --git a/lib/matrix_app_service/migrations.ex b/lib/matrix_app_service/migrations.ex
index 6ae5344..8b3c9f1 100644
--- a/lib/matrix_app_service/migrations.ex
+++ b/lib/matrix_app_service/migrations.ex
@@ -1,4 +1,10 @@
 defmodule MatrixAppService.Migrations do
+  @moduledoc """
+  Module containing migrations for tables used in bridge mode. Should be used like this:
+
+  TODO: example
+  """
+
   use Ecto.Migration
 
   def change do