docs : misc doc generation changes

README.md

@@ -1,5 +1,9 @@
 # GitOps
+
 [![Hex pm](http://img.shields.io/hexpm/v/git_ops.svg?style=flat)](https://hex.pm/packages/git_ops)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/git_ops/)
+[![Total Download](https://img.shields.io/hexpm/dt/git_ops.svg)](https://hex.pm/packages/git_ops)
+[![License](https://img.shields.io/hexpm/l/git_ops.svg)](https://github.com/zachdaniel/git_opts/blob/master/LICENSE)
 [![Build Status](https://travis-ci.com/zachdaniel/git_ops.svg?branch=master)](https://travis-ci.com/zachdaniel/git_ops)
 [![Inline docs](http://inch-ci.org/github/zachdaniel/git_ops.svg?branch=master)](http://inch-ci.org/github/zachdaniel/git_ops)
 [![Coverage Status](https://coveralls.io/repos/github/zachdaniel/git_ops/badge.svg?branch=master)](https://coveralls.io/github/zachdaniel/git_ops?branch=master)
@@ -12,13 +16,12 @@ For an example, see this project's [CHANGELOG.md](https://github.com/zachdaniel/
 
 Roadmap (in no particular order):
 
-* More tests
-* Automatically parse issue numbers and github mentions into the correct format,
-  linking the issue
-* A task to build a compliant commit
-* Validation of commits
-* Automatically link to the PR that merged a given commit in the changelog
-* A hundred other things I forgot to write down while writing the initial version
+  * More tests
+  * Automatically parse issue numbers and github mentions into the correct format, linking the issue
+  * A task to build a compliant commit
+  * Validation of commits
+  * Automatically link to the PR that merged a given commit in the changelog
+  * A hundred other things I forgot to write down while writing the initial version
 
 Important addendums:
 
@@ -43,10 +46,6 @@ def deps do
 end
 ```
 
-## Documentation
-
-View the [hex documentation](https://hexdocs.pm/git_ops)
-
 ## Configuration
 
 ``` elixir
@@ -120,6 +119,6 @@ either the merge commit or alter the commit when merging/squashing (recommended)
 
 ## Similar projects
 
-* https://github.com/glasnoster/eliver
-* https://github.com/oo6/mix-bump
-* https://github.com/mpanarin/versioce
+  * https://github.com/glasnoster/eliver
+  * https://github.com/oo6/mix-bump
+  * https://github.com/mpanarin/versioce

mix.exs

@@ -1,6 +1,7 @@
 defmodule GitOps.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/zachdaniel/git_ops"
   @version "2.0.2"
 
   def project do
@@ -13,7 +14,7 @@ defmodule GitOps.MixProject do
       start_permanent: Mix.env() == :prod,
       name: "Git Ops",
       docs: docs(),
-      source_url: "https://github.com/zachdaniel/git_ops",
+      source_url: @source_url,
       deps: deps(),
       dialyzer: [plt_add_apps: [:mix]],
       test_coverage: [tool: ExCoveralls],
@@ -27,40 +28,42 @@ defmodule GitOps.MixProject do
     ]
   end
 
-  defp description() do
+  defp description do
     """
     A tool for managing the version and changelog of a project using conventional commits.
     """
   end
 
-  defp package() do
+  defp package do
     [
       name: :git_ops,
       maintainers: "Zachary Daniel",
       licenses: ["MIT License"],
       links: %{
-        "GitHub" => "https://github.com/zachdaniel/git_ops"
+        "Changelog" => "#{@source_url}/blob/master/CHANGELOG.md",
+        "GitHub" => @source_url
       }
     ]
   end
 
   defp docs do
     [
       main: "readme",
+      source_url: @source_url,
+      source_ref: "v#{@version}",
       extras: [
-        "README.md"
+        "README.md",
+        "CHANGELOG.md"
       ]
     ]
   end
 
-  # Run "mix help compile.app" to learn about applications.
   def application do
     [
       extra_applications: [:logger]
     ]
   end
 
-  # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
       {:credo, "~> 1.0", only: [:dev, :test], runtime: false},