From 407f9aaaf7a5150c1e75215f86529c261eb92996 Mon Sep 17 00:00:00 2001 From: Christian Koch Date: Wed, 20 Jul 2022 13:49:54 -0500 Subject: [PATCH] chore(Add Changelog): Add commits to changelog. Update readme and add changelog notes. --- CHANGELOG.md | 19 +++++++++++++++++++ README.md | 23 ++++++++++++++++++----- 2 files changed, 37 insertions(+), 5 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d44ea17 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# v0.3.0 + +## Bug Fixes + + * **Add and update tests.** + * update test ([23a7438d71250cad27dcb3c7db4f7c9ced883278](https://github.com/ckochx/ex_factor/commit/23a7438d71250cad27dcb3c7db4f7c9ced883278)) + * **ExFactor.Extractor** + * create path! for new modules ([04d16d93f86432e28faeb492445fc16f240553b7](https://github.com/ckochx/ex_factor/commit/04d16d93f86432e28faeb492445fc16f240553b7)) + +## Breaking Changes + + * **BREAKING CHANGE** + * update min elixir version ([61b6b5759dbd82cb3150324e5f160f60d2b12974](https://github.com/ckochx/ex_factor/commit/61b6b5759dbd82cb3150324e5f160f60d2b12974)) + +# v0.2.0 (2022-05-01) +WIP release + +# v0.1.0 (2022-01-01) +Initial release \ No newline at end of file diff --git a/README.md b/README.md index 8bf8e20..d3b834e 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ Use at your peril, _for now._ - [X] github actions, run test suite - [X] Add Mix.Task tests - [X] Add CLI tests + - [X] Add and configure CHANGELOG tracking. ## Roadmap TODO - - [] Add and configure CHANGELOG tracking. - [] Add test for one file containing more than one `defmodule` - [] How does this work with macro code? Does that even make sense as a case to handle? - [] Update .exs files too? @@ -40,9 +40,19 @@ Use at your peril, _for now._ - [] ElixirLS integration for VSCode? - [] Write the module code to rename usages of the refactored function +## Updates + + See [CHANGELOG.md](https://github.com/ckochx/ex_factor/blob/main/CHANGELOG.md) + + Using [changex](https://github.com/Gazler/changex) to track changes. + +### changex usage: + + `mix changex.update --github ckochx/ex_factor` + ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed +[Hex](https://hex.pm/docs/publish), the package can be installed by adding `ex_factor` to your list of dependencies in `mix.exs`: ```elixir @@ -53,9 +63,12 @@ def deps do end ``` -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can +Documentation is published on [HexDocs](https://hexdocs.pm). The docs can be found at [https://hexdocs.pm/ex_factor](https://hexdocs.pm/ex_factor). Alternate name: - REFACTORY, just in case. \ No newline at end of file + REFACTORY, just in case. + +## License + + See [LICENSE](https://github.com/ckochx/ex_factor/blob/main/LICENSE)