# Changelogs Generator
Hey! This Package is a [changelogs-cli](https://pypi.org/project/changelogs-cli/) package that creates automatic changelogs that supports [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
Since we use Bitbucket, we needed something like this and I wanted to share it publicly in case you need it too.
# Emoji Support
If comments comply with conventional commit rules, they are supported with emoji.
```json
[
"feat": "✅",
"fix": "🚀",
"build": "💚",
"chore": "🚀",
"docs": "📝",
"style": "🎨",
"refactor": "👷",
"perf": "⚡️",
"test": "🧪",
"merge": "🎉",
"revert": "⏪️"
]
````
# Installing
pip install changelogs-cli
# Example
First, let's get into the current your repository.
Example;
```cd /home/repository/```
Example usage is as follows.
changelogs ```example/commits/``` (this should be commit link to show reference on changelogs md.)
# Demo
i will use this repo for example ; https://github.com/qoomon/git-conventional-commits
<img src="https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex1.png">
<img src="https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex2.png">
---
The sample check logs are as follows : [Check it!](./exChangelog.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/AliYmn/changelog",
"name": "changelogs-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Generates git changelog for Conventional Commits",
"author": "Ali Yaman",
"author_email": "aliymn.db@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d0/7f/257aa941f0aa7779eda2159d3320c32cce400e5cf568a59a4b95e8e2c11f/changelogs-cli-1.0.0.tar.gz",
"platform": null,
"description": "# Changelogs Generator\nHey! This Package is a [changelogs-cli](https://pypi.org/project/changelogs-cli/) package that creates automatic changelogs that supports [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)\nSince we use Bitbucket, we needed something like this and I wanted to share it publicly in case you need it too.\n\n# Emoji Support\nIf comments comply with conventional commit rules, they are supported with emoji.\n\n```json\n[\n \"feat\": \"\u2705\",\n \"fix\": \"\ud83d\ude80\",\n \"build\": \"\ud83d\udc9a\",\n \"chore\": \"\ud83d\ude80\",\n \"docs\": \"\ud83d\udcdd\",\n \"style\": \"\ud83c\udfa8\",\n \"refactor\": \"\ud83d\udc77\",\n \"perf\": \"\u26a1\ufe0f\",\n \"test\": \"\ud83e\uddea\",\n \"merge\": \"\ud83c\udf89\",\n \"revert\": \"\u23ea\ufe0f\"\n] \n````\n \n# Installing\n\n pip install changelogs-cli\n\n# Example\n\nFirst, let's get into the current your repository. \n\nExample;\n ```cd /home/repository/```\n\nExample usage is as follows.\n changelogs ```example/commits/``` (this should be commit link to show reference on changelogs md.)\n\n\n# Demo\n\ni will use this repo for example ; https://github.com/qoomon/git-conventional-commits\n\n<img src=\"https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex1.png\">\n\n<img src=\"https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex2.png\">\n\n---\n\nThe sample check logs are as follows : [Check it!](./exChangelog.md)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generates git changelog for Conventional Commits",
"version": "1.0.0",
"split_keywords": [
"generates",
"git",
"changelog",
"for",
"conventional",
"commits"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b291a83dabbdb5deb4f2504c10dfb7c3",
"sha256": "687459f6da5d674c2e675697b1fe15d0d87f2bc4c99ed4308fc8fd7bdbd56009"
},
"downloads": -1,
"filename": "changelogs-cli-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b291a83dabbdb5deb4f2504c10dfb7c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4100,
"upload_time": "2023-01-01T21:24:13",
"upload_time_iso_8601": "2023-01-01T21:24:13.158940Z",
"url": "https://files.pythonhosted.org/packages/d0/7f/257aa941f0aa7779eda2159d3320c32cce400e5cf568a59a4b95e8e2c11f/changelogs-cli-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-01 21:24:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AliYmn",
"github_project": "changelog",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "changelogs-cli"
}
JSON
