Skip to content

Commit

Permalink
Version 0.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Jun 11, 2017
1 parent 6c2cf0b commit dc8b57b
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 6 deletions.
28 changes: 28 additions & 0 deletions CHANGELOG.md
@@ -1,34 +1,62 @@
# CHANGELOG


## Version 0.3.0

### Changes

- *breaking* Updates `mix.exs` with new dependencies, closes [#14](https://github.com/sobolevn/ecto_autoslug_field/issues/14)
- *breaking* Drops `elixir` version 1.2 and `otp` version 17 support

### Improvements

- Updates `cast/4` functions to `cast/3` functions (new Ecto)
- Updates `credo` version and `.credo.exs` config
- Updates `.travis.yml` with credo and new `otp` release

### Bugs

- Fixes dialyxer issues, closes [#10](https://github.com/sobolevn/ecto_autoslug_field/issues/10)

### Documentation

- Updates docs, fixes spelling


## Version 0.2.1

- Added `credo` support
- Added `elixir` version 1.4 support


## Version 0.2.0

- Since this version only `ecto` 2 and above are supported
- Updated docs on how to use this package with older `ecto`
- Credo is not working with this release, please see https://github.com/sobolevn/ecto_autoslug_field/issues/5


## Version 0.1.3

- Now `build_slug/1` is called only when needed, changed docs appropriately
- Replaced `cond` inside `do_generate_slug/3` with more obvious `if`
- Changed tests structure, reached 100% coverage


## Version 0.1.2

- Moved `get_sources/2` and `build_slug/1` definitions into `SlugBase`
- Added `## Options` and `## Function` section to the `README.md`
- Added new tests


## Version 0.1.1

- Since the docs inside `__using__` were unreachable the design of application was changed
- Now `opts` keyword-list contains `:slug_build` parameter with a `build_slug` callback
- Also `coverage` information is updated, since more code is reachable now


## Version 0.1.0

- Initial release
13 changes: 8 additions & 5 deletions README.md
Expand Up @@ -12,14 +12,17 @@ You can find the full documentation online: [docs](https://hexdocs.pm/ecto_autos

```elixir
def deps do
# installation via hex (version 0.2 only supports Ecto >= 2.0):
[{:ecto_autoslug_field, "~> 0.2"}]
# installation via hex (version 0.3 only supports `{:ecto, "~> 2.1"}`):
[{:ecto_autoslug_field, "~> 0.3"}]

# if you want to use github:
# [{:ecto_autoslug_field, github: "sobolevn/ecto_autoslug_field"}]

# if you need support for `{:ecto, "~> 2.0"}`:
# [{:ecto_autoslug_field, "~> 0.2"}]

# if you need support for older Ecto versions (< 2.0):
# [{:ecto_autoslug_field, "0.1.3"}]
# [{:ecto_autoslug_field, "~> 0.1.3"}]
end
```

Expand All @@ -33,8 +36,8 @@ Required:

Optional:

- `:from` - represents the source fields from which to build slug, if this option is not set you have to ovveride `get_sources/2` function
- `:always_change` - if this option is set slug will be recreated from the givven sources each time `maybe_generate_slug` function is called
- `:from` - represents the source fields from which to build slug, if this option is not set you have to override `get_sources/2` function
- `:always_change` - if this option is set slug will be recreated from the given sources each time `maybe_generate_slug` function is called

## Functions

Expand Down
2 changes: 1 addition & 1 deletion mix.exs
@@ -1,7 +1,7 @@
defmodule EctoAutoslugField.Mixfile do
use Mix.Project

@version "0.2.1"
@version "0.3.0"
@url "https://github.com/sobolevn/ecto_autoslug_field"

def project do
Expand Down

0 comments on commit dc8b57b

Please sign in to comment.