Skip to content

Commit 22ee623

Browse files
author
Longbridge Dev
committed
docs: add CHANGELOG and LICENSE to mix docs and package files
- add MIT LICENSE file (declared in package but missing from repo) - include CHANGELOG.md and LICENSE in docs() extras - include LICENSE in package files list so it ships to Hex - skip undefined-reference warnings for CHANGELOG.md (release notes reference @doc false internals like Config.refresh_access_token/2)
1 parent 3d44874 commit 22ee623

2 files changed

Lines changed: 24 additions & 2 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 gilbertwong96
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

mix.exs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,10 @@ defmodule Longbridge.MixProject do
3939
main: "readme",
4040
source_url: "https://github.com/gilbertwong96/longbridge",
4141
homepage_url: "https://github.com/gilbertwong96/longbridge",
42-
extras: ["README.md"],
42+
extras: ["README.md", "CHANGELOG.md", "LICENSE"],
4343
skip_undefined_reference_warnings_on: [
4444
"README.md",
45+
"CHANGELOG.md",
4546
"lib/longbridge/quote_context.ex",
4647
# References `Longbridge.OAuth.token_path/1` which is @doc false
4748
# (a back-compat shim kept for callers that imported it before
@@ -142,7 +143,7 @@ defmodule Longbridge.MixProject do
142143
"Upstream" => "https://github.com/longbridge/longbridge",
143144
"Longbridge" => "https://open.longbridge.com"
144145
},
145-
files: ~w[lib protos .formatter.exs mix.exs README.md]
146+
files: ~w[lib protos .formatter.exs mix.exs README.md CHANGELOG.md LICENSE]
146147
]
147148
end
148149
end

0 commit comments

Comments
 (0)