Skip to content

Commit

Permalink
ex/docs: update mix docs generation (#29)
Browse files Browse the repository at this point in the history
* docs: update mix docs generation

* chore: formatting

* chore: publish package only
  • Loading branch information
Ziinc authored Jun 11, 2024
1 parent ea5f751 commit d3d8df8
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ex-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- run: mix deps.get
- run: echo "short_sha=`echo ${GITHUB_SHA} | cut -c1-7`" >> $GITHUB_ENV
- run: echo "timestamp=`date +%s`" >> $GITHUB_ENV
- run: mix hex.publish --yes
- run: mix hex.publish package --yes
if: github.event_name == 'push'
env:
HEX_API_KEY: ${{ secrets.HEX_AUTH_TOKEN }}
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Supported languages and integrations:
- LoggerBackend - a backend for Logger
- TelemetryReporter - a telemetry reporter module for `:telemetry_metrics`


## Development

Release tags are prefixed with the language followed by the version, such as `js/v0.1.0`.
Expand Down
19 changes: 17 additions & 2 deletions ex/mix.exs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
defmodule LogflareEx.MixProject do
use Mix.Project

@source_url "https://github.com/Logflare/warehouse-sdk"
@prerelease System.get_env("LOGFLARE_EX_PRERELEASE_VERSION")
@version_suffix if(@prerelease, do: "-#{@prerelease}", else: "")
def project do
Expand All @@ -15,6 +16,7 @@ defmodule LogflareEx.MixProject do
start_permanent: Mix.env() == :prod,
deps: deps(),
aliases: aliases(),
docs: docs(),
preferred_cli_env: [
"test.format": :test,
"test.compile": :test
Expand Down Expand Up @@ -69,9 +71,22 @@ defmodule LogflareEx.MixProject do

defp package() do
[
description: "Logflare Elixir SDK",
description: "Warehouse Elixir SDK",
licenses: ["MIT"],
links: %{"GitHub" => "https://github.com/Logflare/logflare-sdk"}
links: %{"GitHub" => @source_url}
]
end

defp docs do
[
extras: [
"README.md": [title: "Overview"]
],
main: "readme",
homepage_url: "https://hex.pm/packages/warehouse_ex",
source_url: @source_url,
formatters: ["html"],
filter_modules: ~r/.+\..+\..+$/
]
end
end

0 comments on commit d3d8df8

Please sign in to comment.