ProductPromotion
Logo

Elixir

made by https://0x3d.site

GitHub - Gazler/changex: Automated changelog generation from git logs
Automated changelog generation from git logs. Contribute to Gazler/changex development by creating an account on GitHub.
Visit Site

GitHub - Gazler/changex: Automated changelog generation from git logs

GitHub - Gazler/changex: Automated changelog generation from git logs

Changex

Mix tasks for parsing git log.

Build Status

Usage

Add Changex as a dependency in your mix.exs file.

def deps do
  [ { :changex } ]
end

After you are done, run mix deps.get to fetch and compile Changex. You will now have access to the changex mix tasks in your project.

Mix Tasks

Changex.Diff

If you run mix changex.diff then a diff based on your git commit history will be generated. This can be called in several way:

To generate a changelog from the most recent tag (the root commit will be used if there are no tags) to the git HEAD run:

mix changex.diff

To generate a changelog from a git reference (commit, tag, etc.) to HEAD run:

mix changex.diff a87a32f
mix changex.diff v0.1.0
mix changex.diff HEAD~5

To generate a changelog between two commit references:

mix changex.diff a87a32f v0.1.0
mix changex.diff v0.1.0 v0.1.1
mix changex.diff HEAD~5 HEAD~2

The following options are also available:

Option          Description
----------      ------
--dir           Run changex.diff using a directory other than the current one
--format        Change the output format. One of terminal, markdown or elixir
--github        Include link to commit on GitHub when outputting the hash of
                the commit. Should be in the format `/user/repo`

Changex.Update

If you run mix changex.update then the changelog file in the repository will be updated. This will use the most recent tag if available, if not then it will use the root node of the repository.

To write to the file CHANGELOG.md run:

mix changex.update

The following options are also available:

Option          Description
----------      ------
--file          Change the file for the output to be written to. Defaults to CHANGELOG.md
--format        Change the output format. One of markdown or elixir, defaults to markdown
--github        Include link to commit on GitHub when outputting the hash of
                the commit. Should be in the format `/user/repo`

Contributing

Changex uses GitCop to automatically check for formatting of the commit messages. Any pull request will automatically be checked against the rules specified in this repository.

Please read CONTRIBUTING.md.

License

Please read LICENSE.txt.

Articles
to learn more about the elixir concepts.

Resources
which are currently available to browse on.

mail [email protected] to add your project or resources here 🔥.

FAQ's
to know more about the topic.

mail [email protected] to add your project or resources here 🔥.

Queries
or most google FAQ's about Elixir.

mail [email protected] to add more queries here 🔍.

More Sites
to check out once you're finished browsing here.

0x3d
https://www.0x3d.site/
0x3d is designed for aggregating information.
NodeJS
https://nodejs.0x3d.site/
NodeJS Online Directory
Cross Platform
https://cross-platform.0x3d.site/
Cross Platform Online Directory
Open Source
https://open-source.0x3d.site/
Open Source Online Directory
Analytics
https://analytics.0x3d.site/
Analytics Online Directory
JavaScript
https://javascript.0x3d.site/
JavaScript Online Directory
GoLang
https://golang.0x3d.site/
GoLang Online Directory
Python
https://python.0x3d.site/
Python Online Directory
Swift
https://swift.0x3d.site/
Swift Online Directory
Rust
https://rust.0x3d.site/
Rust Online Directory
Scala
https://scala.0x3d.site/
Scala Online Directory
Ruby
https://ruby.0x3d.site/
Ruby Online Directory
Clojure
https://clojure.0x3d.site/
Clojure Online Directory
Elixir
https://elixir.0x3d.site/
Elixir Online Directory
Elm
https://elm.0x3d.site/
Elm Online Directory
Lua
https://lua.0x3d.site/
Lua Online Directory
C Programming
https://c-programming.0x3d.site/
C Programming Online Directory
C++ Programming
https://cpp-programming.0x3d.site/
C++ Programming Online Directory
R Programming
https://r-programming.0x3d.site/
R Programming Online Directory
Perl
https://perl.0x3d.site/
Perl Online Directory
Java
https://java.0x3d.site/
Java Online Directory
Kotlin
https://kotlin.0x3d.site/
Kotlin Online Directory
PHP
https://php.0x3d.site/
PHP Online Directory
React JS
https://react.0x3d.site/
React JS Online Directory
Angular
https://angular.0x3d.site/
Angular JS Online Directory