Merge pull request #19 from PostHog/improve-docs

Author: rafaeelaudibert

.github/workflows/cd.yml

@@ -52,7 +52,7 @@ jobs:
         id: versions
         if: steps.bump-type.outputs.bump-type != 'null'
         run: |
-          OLD_VERSION=$(grep 'version:' mix.exs | grep -o '"[0-9]\+\.[0-9]\+\.[0-9]\+"' | tr -d '"')
+          OLD_VERSION=$(grep '@version "' mix.exs | grep -o '"[0-9]\+\.[0-9]\+\.[0-9]\+"' | tr -d '"')
 
           # Function to bump version using cut
           bump_version() {
@@ -81,7 +81,7 @@ jobs:
       - name: Update version in mix.exs
         if: steps.bump-type.outputs.bump-type != 'null'
         run: |
-          sed -i "s/version: \"${{ steps.versions.outputs.old-version }}\"/version: \"${{ steps.versions.outputs.new-version }}\"/" mix.exs
+          sed -i "s/@version \"${{ steps.versions.outputs.old-version }}\"/@version \"${{ steps.versions.outputs.new-version }}\"/" mix.exs
 
       - name: Update CHANGELOG.md
         run: |
@@ -96,7 +96,8 @@ jobs:
         uses: EndBug/add-and-commit@v7
         with:
           branch: ${{ github.event.pull_request.base.ref }}
-          message: "chore: Bump version to ${{ steps.versions.outputs.new-version }}"
+          tag: "v${{ steps.versions.outputs.new-version }}"
+          message: "chore: Bump version to v${{ steps.versions.outputs.new-version }}"
           github_token: ${{ secrets.POSTHOG_BOT_GITHUB_TOKEN }}
 
       - name: Publish to Hex.pm

docs/cover.jpeg

@@ -1,6 +1,8 @@
 defmodule Posthog.MixProject do
   use Mix.Project
 
+  @version "0.4.2"
+
   def project do
     [
       app: :posthog,
@@ -9,9 +11,9 @@ defmodule Posthog.MixProject do
       elixir: "~> 1.12",
       elixirc_paths: elixirc_paths(Mix.env()),
       package: package(),
-      source_url: "https://github.com/posthog/posthog-elixir",
+      docs: docs(),
       start_permanent: Mix.env() == :prod,
-      version: "0.4.2"
+      version: @version
     ]
   end
 
@@ -40,6 +42,17 @@ defmodule Posthog.MixProject do
     ]
   end
 
+  defp docs do
+    [
+      cover: "docs/cover.jpeg",
+      favicon: "docs/favicon.svg",
+      logo: "docs/favicon.svg",
+      source_ref: "v#{@version}",
+      source_url: "https://github.com/posthog/posthog-elixir",
+      extras: ["README.md"]
+    ]
+  end
+
   defp deps do
     [
       {:dialyxir, "~> 1.3", only: [:dev, :test], runtime: false},