Skip to content

Commit 59f1b36

Browse files
author
Chris Wögi
authored
Changelog improvement (#124)
* Rename CHANGELOG Removed the format meta descriptions. - Format isn't that important (human readability is!) - SemVer is anyway standard Added diff link tags at the bottom of the file. Important for the one who are making releases. Need to update! * Add CHANGELOG.md and guide for Windows to docs
1 parent 9237666 commit 59f1b36

3 files changed

Lines changed: 50 additions & 30 deletions

File tree

CHANGELOG

Lines changed: 0 additions & 23 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Changelog
2+
3+
## [Unreleased]
4+
5+
### Added
6+
- Guide for Windows users
7+
8+
## [0.5.1] - 2021-03-19
9+
10+
### Changed
11+
- Bumped SQLite3 amalgamation to version 3.35.2
12+
- Replaced old references of [github.com/warmwaffles](http://github.com/warmwaffles)
13+
14+
## [0.5.0] - 2021-03-17
15+
16+
### Removed
17+
- Removed `Ecto.Adapters.Exqlite`
18+
Replaced with [Ecto Sqlite3][ecto_sqlite3] library.
19+
20+
21+
[ecto_sqlite3]: <https://github.com/elixir-sqlite/ecto_sqlite3>
22+
23+
[Unreleased]: https://github.com/elixir-sqlite/exqlite/compare/v0.5.1...main
24+
[0.5.1]: https://github.com/elixir-sqlite/exqlite/compare/v0.5.0...v0.5.1
25+
[0.5.0]: https://github.com/elixir-sqlite/exqlite/compare/v0.4.9...v0.5.0

mix.exs

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ defmodule Exqlite.MixProject do
1010
make_targets: ["all"],
1111
make_clean: ["clean"],
1212
start_permanent: Mix.env() == :prod,
13-
source_url: "https://github.com/elixir-sqlite/exqlite",
14-
homepage_url: "https://github.com/elixir-sqlite/exqlite",
1513
deps: deps(),
1614
package: package(),
1715
description: description(),
1816
test_paths: test_paths(System.get_env("EXQLITE_INTEGRATION")),
19-
elixirc_paths: elixirc_paths(Mix.env())
17+
elixirc_paths: elixirc_paths(Mix.env()),
18+
19+
# Docs
20+
name: "Exqlite",
21+
source_url: "https://github.com/elixir-sqlite/exqlite",
22+
homepage_url: "https://github.com/elixir-sqlite/exqlite",
23+
docs: docs()
2024
]
2125
end
2226

@@ -32,8 +36,8 @@ defmodule Exqlite.MixProject do
3236
[
3337
{:db_connection, "~> 2.1"},
3438
{:elixir_make, "~> 0.6", runtime: false},
35-
{:ex_doc, "~> 0.23.0", only: [:dev], runtime: false},
36-
{:temp, "~> 0.4", only: [:test]},
39+
{:ex_doc, "~> 0.24", only: [:dev], runtime: false},
40+
{:temp, "~> 0.4", only: [:test]}
3741
]
3842
end
3943

@@ -57,12 +61,26 @@ defmodule Exqlite.MixProject do
5761
name: "exqlite",
5862
licenses: ["MIT"],
5963
links: %{
60-
"GitHub" => "https://github.com/elixir-sqlite/exqlite",
61-
"docs" => "https://hexdocs.pm/exqlite"
64+
"GitHub" => "https://github.com/elixir-sqlite/exqlite"
6265
}
6366
]
6467
end
6568

69+
defp docs do
70+
[
71+
main: "readme",
72+
extras: docs_extras()
73+
]
74+
end
75+
76+
defp docs_extras do
77+
[
78+
"README.md",
79+
"guides/windows.md",
80+
"CHANGELOG.md"
81+
]
82+
end
83+
6684
defp elixirc_paths(:test), do: ["lib", "test/support"]
6785
defp elixirc_paths(_), do: ["lib"]
6886

0 commit comments

Comments
 (0)