{"id":13509047,"url":"https://github.com/Gazler/changex","last_synced_at":"2025-03-30T13:31:22.247Z","repository":{"id":19825806,"uuid":"23086824","full_name":"Gazler/changex","owner":"Gazler","description":"Automated changelog generation from git logs","archived":false,"fork":false,"pushed_at":"2022-03-16T12:17:27.000Z","size":80,"stargazers_count":47,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-27T11:49:27.958Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/changex","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Gazler.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-18T21:19:06.000Z","updated_at":"2024-03-03T12:13:18.000Z","dependencies_parsed_at":"2022-08-21T14:41:00.074Z","dependency_job_id":null,"html_url":"https://github.com/Gazler/changex","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gazler%2Fchangex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gazler%2Fchangex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gazler%2Fchangex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gazler%2Fchangex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gazler","download_url":"https://codeload.github.com/Gazler/changex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222552352,"owners_count":17002053,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T02:01:02.290Z","updated_at":"2024-11-01T09:30:24.101Z","avatar_url":"https://github.com/Gazler.png","language":"Elixir","funding_links":[],"categories":["Release Management"],"sub_categories":[],"readme":"# Changex\n\nMix tasks for parsing git log.\n\n[![Build Status](https://travis-ci.org/Gazler/changex.svg?branch=fix%2Ftravis-ci)](https://travis-ci.org/Gazler/changex)\n\n## Usage\n\nAdd Changex as a dependency in your `mix.exs` file.\n\n```elixir\ndef deps do\n  [ { :changex } ]\nend\n```\n\nAfter 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.\n\n## Mix Tasks\n\n### Changex.Diff\n\nIf you run `mix changex.diff` then a diff based on your git commit history will be generated. This can be called in several way:\n\n\nTo generate a changelog from the most recent tag (the root commit will be used if there are no tags) to the git HEAD run:\n\n```elixir\nmix changex.diff\n```\n\nTo generate a changelog from a git reference (commit, tag, etc.) to HEAD run:\n\n```elixir\nmix changex.diff a87a32f\nmix changex.diff v0.1.0\nmix changex.diff HEAD~5\n```\n\nTo generate a changelog between two commit references:\n\n```elixir\nmix changex.diff a87a32f v0.1.0\nmix changex.diff v0.1.0 v0.1.1\nmix changex.diff HEAD~5 HEAD~2\n```\n\nThe following options are also available:\n\n    Option          Description\n    ----------      ------\n    --dir           Run changex.diff using a directory other than the current one\n    --format        Change the output format. One of terminal, markdown or elixir\n    --github        Include link to commit on GitHub when outputting the hash of\n                    the commit. Should be in the format `/user/repo`\n\n### Changex.Update\n\nIf 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.\n\n\nTo write to the file CHANGELOG.md run:\n\n```elixir\nmix changex.update\n```\n\nThe following options are also available:\n\n    Option          Description\n    ----------      ------\n    --file          Change the file for the output to be written to. Defaults to CHANGELOG.md\n    --format        Change the output format. One of markdown or elixir, defaults to markdown\n    --github        Include link to commit on GitHub when outputting the hash of\n                    the commit. Should be in the format `/user/repo`\n\n## Contributing\n\nChangex uses [GitCop](http://gitcop.com) to automatically check for formatting of the commit messages. Any pull request will automatically be checked against the rules specified in this repository.\n\nPlease read [CONTRIBUTING.md](https://github.com/Gazler/changex/blob/master/CONTRIBUTING.md).\n\n## License\n\nPlease read [LICENSE.txt](https://github.com/Gazler/changex/blob/master/LICENSE.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGazler%2Fchangex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGazler%2Fchangex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGazler%2Fchangex/lists"}