{"id":21700702,"url":"https://github.com/marcocesarato/php-conventional-changelog","last_synced_at":"2025-05-16T08:06:41.432Z","repository":{"id":38461276,"uuid":"330274698","full_name":"marcocesarato/php-conventional-changelog","owner":"marcocesarato","description":"A PHP tool built to generate a changelog from a project's commit messages and metadata following the conventionalcommits.org and automate versioning with semver.org.","archived":false,"fork":false,"pushed_at":"2024-05-19T14:36:33.000Z","size":661,"stargazers_count":240,"open_issues_count":23,"forks_count":32,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-10T20:01:47.984Z","etag":null,"topics":["autoversion","autoversioning","changelog","commit","commits","composer","convention","conventional","conventional-changelog","conventional-changelog-preset","conventional-commit","conventional-commits","generation","git","history","php","php-conventional-changelog","php-convetional-commit","semver","tool"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcocesarato.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-16T23:03:08.000Z","updated_at":"2025-04-26T05:39:24.000Z","dependencies_parsed_at":"2024-01-02T14:27:53.040Z","dependency_job_id":"8728f053-08f0-4b2f-b76b-826efe977e19","html_url":"https://github.com/marcocesarato/php-conventional-changelog","commit_stats":{"total_commits":351,"total_committers":22,"mean_commits":"15.954545454545455","dds":"0.41310541310541316","last_synced_commit":"9269b0a3198d2107322f9f9a0fca399719825f67"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2Fphp-conventional-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2Fphp-conventional-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2Fphp-conventional-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2Fphp-conventional-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcocesarato","download_url":"https://codeload.github.com/marcocesarato/php-conventional-changelog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254493378,"owners_count":22080126,"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":["autoversion","autoversioning","changelog","commit","commits","composer","convention","conventional","conventional-changelog","conventional-changelog-preset","conventional-commit","conventional-commits","generation","git","history","php","php-conventional-changelog","php-convetional-commit","semver","tool"],"created_at":"2024-11-25T20:16:24.257Z","updated_at":"2025-05-16T08:06:36.423Z","avatar_url":"https://github.com/marcocesarato.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\r\n\r\n\u003ch1 align=\"center\"\u003ePHP Conventional Changelog\u003c/h1\u003e\r\n\r\n![Version](https://img.shields.io/badge/version-1.17.2-brightgreen?style=for-the-badge)\r\n![Requirements](https://img.shields.io/badge/php-%3E%3D%207.1.3-4F5D95?style=for-the-badge)\r\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow?style=for-the-badge)](https://conventionalcommits.org)\r\n![License](https://img.shields.io/github/license/marcocesarato/php-conventional-changelog?style=for-the-badge)\r\n[![GitHub](https://img.shields.io/badge/GitHub-Repo-6f42c1?style=for-the-badge)](https://github.com/marcocesarato/php-conventional-changelog)\r\n\r\n#### If this project helped you out, please support us with a star :star:\r\n\r\n\u003cbr\u003e\r\n\r\n![](docs/images/logo.png)\r\n\r\n\u003c/div\u003e\r\n\r\n## Description\r\n\r\nWhen a new release of a software project is announced, it is convenient to generate documents that let the project \r\nusers know what were the changes and other relevant notes about the new project release.\r\n\r\nThis package can help to automatically generate changelog and release note files, so the developers of the project \r\nreduce the work that is necessary to finalize and check the new release of the project.\r\n\r\nThis package can generate a changelog from a project's committing history messages and metadata using composer and automate versioning\r\nwith [**semver**](https://semver.org) and [**conventional-commits**](https://conventionalcommits.org).\r\n\r\nIt provides a command that can be run from the terminal, or using composer scripts, \r\nto generate a changelog file in **markdown** for the current project.\r\n\r\nThe command may take parameters that define the releases of the project that will be considered to extract the changes\r\nfrom the git history to generate the file. The package uses a configuration system with that permit to customize the\r\nsettings you may want to have your desired changelog generated.\r\n\r\nLook at our [CHANGELOG](CHANGELOG.md) file if you are looking for an example of a possible final result.\r\n\r\n### How to contribute\r\n\r\nHave an idea? Found a bug? Please raise to [ISSUES](https://github.com/marcocesarato/php-conventional-changelog/issues)\r\nor [PULL REQUEST](https://github.com/marcocesarato/php-conventional-changelog/pulls). Contributions are welcome and are\r\ngreatly appreciated! Every little bit helps.\r\n\r\n## 📘 Requirements\r\n- [php](https://www.php.net) \u003e= 7.1.3\r\n- [git](https://git-scm.com) \u003e= 2.1.4\r\n\r\n## 📖 Installation\r\n\r\nYou can install it easily with composer\r\n\r\n`composer require --dev marcocesarato/php-conventional-changelog`\r\n\r\n#### Scripts *(Optional)*\r\n\r\nFor easy use the changelog generator or release faster your new version you can add to your `composer.json` the scripts:\r\n\r\n\u003e **Notes:** you can customize it according to your needs\r\n\r\n```\r\n{\r\n  ...\r\n  \"scripts\": {\r\n    \"changelog\": \"conventional-changelog\",\r\n    \"release\": \"conventional-changelog --commit\",\r\n    \"release:patch\": \"conventional-changelog --patch --commit\",\r\n    \"release:minor\": \"conventional-changelog --minor --commit\",\r\n    \"release:major\": \"conventional-changelog --major --commit\"\r\n  },\r\n  ...\r\n}\r\n```\r\n\r\nNow you can just run `composer changelog` or `composer release` (the last one will autobump the version code and commit changes) to generate your changelog.\r\n\r\n## 📘 Configuration\r\n\r\n\u003e **Notes:** this procedure is *optional* and permit to overwriting/merging the default settings\r\n\r\nFor customize settings you just needs to create a file named `.changelog` on the root of your project/on the working\r\ndir or use the `--config` option to specify the location of your configuration file.\r\n\r\n\u003e **Notes:**\u003cbr\u003e\r\n\u003e - When a setting on the configuration file is not necessary just omit it\r\n\u003e - The default ignored types are: `build`, `chore`, `ci`, `docs`, `perf`, `refactor`, `revert`, `style`, `test`\r\n\u003e - To allow all types just keep empty `types` and set empty `ignoreTypes`\r\n\r\nYou can have more info about reading the [config documentation](./docs/config.md).\r\n\r\n## 💻 Usage\r\n\r\nThe changelog generator will generate a log of changes from the date of the last tag to the current date, and it will\r\nput all commit logs in the latest version just created.\r\n\r\n![](docs/images/usage.gif)\r\n\r\n\u003e **Notes:**\u003cbr\u003e\r\n\u003e - Some of these options listed on examples could be used together at the same time (ex. `--first-release --commit`)\r\n\u003e - Auto bump of version code using the [Semantic Versioning](https://semver.org) (`MAJOR.MINOR.PATCH`) is enabled by default if not specified the release method.\r\n\u003e    - `MAJOR`: At least one breaking change.\r\n\u003e    - `MINOR`: At least one new feature.\r\n\u003e    - `PATCH`: Default\r\n\u003e - Use these options to specify the release method: `--major`, `--minor`, `--patch`, `--rc`, `--beta`, `--alpha`.\r\n\r\n### Examples\r\n\r\n#### First version\r\n\r\n\u003e **Notes:** use this option only if you don't need all history changes or is the first version, else run with `--history` option\r\n\r\nTo generate your changelog for the first version run:\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --first-release\r\n```\r\n\r\n#### New version\r\n\r\nTo generate your changelog *(without committing files)*\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog\r\n```\r\n\r\n#### New release (with commit and tag)\r\n\r\nTo generate your changelog with auto commit and auto versioning tagging run:\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --commit\r\n```\r\n\r\nor to amend at an existing commit you can run:\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --amend\r\n```\r\n\r\n#### History\r\n\r\nTo generate your changelog with the entire history of changes of all releases\r\n\r\n\u003e **Warn:** this operation will overwrite the `CHANGELOG.md` file if it already exists\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --history\r\n```\r\n\r\n#### Date range\r\n\r\nTo generate your changelog from a specified date to another specified date\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --from-date=\"2020-12-01\" --to-date=\"2021-01-01\"\r\n```\r\n\r\n#### Tag range\r\n\r\nTo generate your changelog from a specified tag to another specified tag\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --from-tag=\"v1.0.2\" --to-tag=\"1.0.4\"\r\n```\r\n\r\n#### Specific version\r\n\r\nTo generate your changelog with a specific version code\r\n\r\n```shell\r\nphp vendor/bin/conventional-changelog --ver=\"2.0.1\"\r\n```\r\n\r\n### Commands List\r\n\r\n\u003e **Info:** You can have more info about running  `php vendor/bin/conventional-changelog --help`\r\n\r\n```\r\nDescription:\r\n  Generate changelogs and release notes from a project's commit messagesand metadata and automate versioning with semver.org and conventionalcommits.org\r\n\r\nUsage:\r\n  changelog [options] [--] [\u003cpath\u003e]\r\n\r\nArguments:\r\n  path                               Specify the path directory where generate changelog\r\n\r\nOptions:\r\n      --config=CONFIG                Specify the configuration file path\r\n  -c, --commit                       Commit the new release once changelog is generated\r\n  -a, --amend                        Amend commit the new release once changelog is generated\r\n      --commit-all                   Commit all changes the new release once changelog is generated\r\n      --first-release                Run at first release (if --ver isn't specified version code it will be 1.0.0)\r\n      --from-date=FROM-DATE          Get commits from specified date [YYYY-MM-DD]\r\n      --to-date=TO-DATE              Get commits last tag date (or specified on --from-date) to specified date [YYYY-MM-DD]\r\n      --from-tag=FROM-TAG            Get commits from specified tag\r\n      --to-tag=TO-TAG                Get commits last tag (or specified on --from-tag) to specified tag\r\n      --major                        Major release (important changes)\r\n      --minor                        Minor release (add functionality)\r\n      --patch                        Patch release (bug fixes) [default]\r\n      --rc                           Release candidate\r\n      --beta                         Beta release\r\n      --alpha                        Alpha release\r\n      --ver=VER                      Specify the next release version code (semver)\r\n      --history                      Generate the entire history of changes of all releases\r\n      --no-verify                    Bypasses the pre-commit and commit-msg hooks\r\n      --no-tag                       Disable release auto tagging\r\n      --no-change-without-commits    Do not apply change if no commits\r\n      --annotate-tag[=ANNOTATE-TAG]  Make an unsigned, annotated tag object once changelog is generated [default: false]\r\n      --merged                       Only include commits whose tips are reachable from HEAD\r\n  -h, --help                         Display help for the given command. When no command is given display help for the changelog command\r\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcocesarato%2Fphp-conventional-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcocesarato%2Fphp-conventional-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcocesarato%2Fphp-conventional-changelog/lists"}