Skip to content

Commit c6c7557

Browse files
committed
supe up mix.exs for publishing
1 parent 06f79ea commit c6c7557

3 files changed

Lines changed: 65 additions & 2 deletions

File tree

.version

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
v0.0.0
2+
3+
# this file will be clobbered by github actions.
4+
# to version bump, only create new tag in git, with v + semver.
5+
#
6+
# example tag would be: v0.1.5

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a
6+
Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
7+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8+
9+
## 0.1.0 - [UNRELEASED]
10+
11+
### Added
12+
13+
- Initial implementation

mix.exs

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
defmodule MintWebSocket.MixProject do
22
use Mix.Project
33

4+
@source_url "https://github.com/NFIBrokerage/mint_web_socket"
5+
@version_file Path.join(__DIR__, ".version")
6+
@external_resource @version_file
7+
@version (case Regex.run(~r/^v([\d\.\w-]+)/, File.read!(@version_file), capture: :all_but_first) do
8+
[version] -> version
9+
nil -> "0.0.0"
10+
end)
11+
412
def project do
513
[
614
app: :mint_web_socket,
7-
version: "0.1.0",
15+
version: @version,
816
elixir: "~> 1.8",
917
elixirc_paths: elixirc_paths(Mix.env()),
1018
erlc_paths: erlc_paths(Mix.env()),
@@ -18,7 +26,12 @@ defmodule MintWebSocket.MixProject do
1826
docs: :dev,
1927
bless: :test,
2028
credo: :test
21-
]
29+
],
30+
package: package(),
31+
description: description(),
32+
source_url: @source_url,
33+
name: "MintWebSocket",
34+
docs: docs()
2235
]
2336
end
2437

@@ -46,4 +59,35 @@ defmodule MintWebSocket.MixProject do
4659

4760
defp erlc_paths(:test), do: ["src", "test/fixtures"]
4861
defp erlc_paths(_), do: ["src"]
62+
63+
defp package do
64+
[
65+
name: "mint_web_socket",
66+
files: ~w(lib .formatter.exs mix.exs README.md .version),
67+
licenses: ["Apache-2.0"],
68+
links: %{
69+
"GitHub" => @source_url,
70+
"Changelog" => @source_url <> "/blob/main/CHANGELOG.md"
71+
}
72+
]
73+
end
74+
75+
defp description do
76+
"(Unofficial) WebSocket support for Mint"
77+
end
78+
79+
defp docs do
80+
[
81+
deps: [],
82+
language: "en",
83+
formatters: ["html"],
84+
main: Mint.WebSocket,
85+
extras: [
86+
"CHANGELOG.md"
87+
],
88+
skip_undefined_reference_warnings_on: [
89+
"CHANGELOG.md"
90+
]
91+
]
92+
end
4993
end

0 commit comments

Comments
 (0)