Skip to content

Commit

Permalink
VIP - Add Changelog, add some options for docs, fix docs links issue
Browse files Browse the repository at this point in the history
  • Loading branch information
shahryarjb committed Jul 2, 2024
1 parent 3fdd66e commit 0f5de3d
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 11 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog for MishkaInstaller 0.1.0

> Kindly ensure that the MishkaInstaller Library is updated as quickly as feasible. This version includes rewriting whole project. It should be noted we do not support previous versions.
You will see that this version of the project has undergone a total overhaul, and the strategy that was taken to it has been radically altered.

Because of this, it is not possible to write down the details, and each area has its own document that you are able to study thoroughly.
4 changes: 2 additions & 2 deletions lib/mishka_installer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ defmodule MishkaInstaller do
##### This library is divided into the following main sections:
- [Events and Hook](#events-and-hook)
- [Plugin management system theory and installation of Elixir libraries at runtime](#plugin-management-system-theory-and-installation-of-elixir-libraries-at-runtime)
- [Events and Hook](#module-events-and-hook)
- [Plugin management system theory and installation of Elixir libraries at runtime](#module-plugin-management-system-theory-and-installation-of-elixir-libraries-at-runtime)
### Events and Hook
Expand Down
29 changes: 20 additions & 9 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule MishkaInstaller.MixProject do
use Mix.Project

@version "0.1.0-alpha.2"
@version "0.1.0"
@source_url "https://github.com/mishka-group/mishka_installer"

def project do
Expand All @@ -17,12 +17,7 @@ defmodule MishkaInstaller.MixProject do
package: package(),
homepage_url: "https://github.com/mishka-group",
source_url: @source_url,
docs: [
main: "MishkaInstaller",
source_ref: "master",
extras: ["README.md"],
source_url: @source_url
],
docs: docs(),
test_coverage: [
ignore_modules: [
MishkaInstaller.MnesiaRepo.State,
Expand Down Expand Up @@ -52,6 +47,7 @@ defmodule MishkaInstaller.MixProject do

# Extra tools
{:mishka_developer_tools, "~> 0.1.7"},
# We will cover telemetry in whole project
{:telemetry, "~> 1.2.1"},

# Dev and Test dependencies
Expand All @@ -69,10 +65,25 @@ defmodule MishkaInstaller.MixProject do

defp package() do
[
files: ~w(lib .formatter.exs mix.exs LICENSE README*),
files: ~w(lib .formatter.exs mix.exs LICENSE README* Changelog.md),
licenses: ["Apache-2.0"],
maintainers: ["Shahryar Tavakkoli"],
links: %{"GitHub" => @source_url}
links: %{
"GitHub" => @source_url,
"Changelog" => "https://hexdocs.pm/mishka_installer/changelog.html"
}
]
end

defp docs() do
[
main: "readme",
source_ref: "v#{@version}",
extras: [
"README.md",
"CHANGELOG.md"
],
source_url: @source_url
]
end
end

0 comments on commit 0f5de3d

Please sign in to comment.