{"id":21327381,"url":"https://github.com/wanadev/changelogify","last_synced_at":"2025-07-12T07:31:19.832Z","repository":{"id":47661123,"uuid":"236995919","full_name":"wanadev/changelogify","owner":"wanadev","description":"A basic changelog manager made to avoid conflicts at git merge","archived":false,"fork":false,"pushed_at":"2025-02-12T16:55:59.000Z","size":94,"stargazers_count":6,"open_issues_count":2,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-18T11:08:07.951Z","etag":null,"topics":["avoid-conflicts","changelog","changelog-generator","merge-conflict","npm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wanadev.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":"2020-01-29T14:04:51.000Z","updated_at":"2025-02-12T16:56:01.000Z","dependencies_parsed_at":"2025-02-12T17:36:03.506Z","dependency_job_id":null,"html_url":"https://github.com/wanadev/changelogify","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/wanadev/changelogify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fchangelogify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fchangelogify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fchangelogify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fchangelogify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wanadev","download_url":"https://codeload.github.com/wanadev/changelogify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fchangelogify/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264958135,"owners_count":23689006,"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":["avoid-conflicts","changelog","changelog-generator","merge-conflict","npm"],"created_at":"2024-11-21T21:17:00.374Z","updated_at":"2025-07-12T07:31:19.826Z","avatar_url":"https://github.com/wanadev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Changelogify\n\nA basic changelog manager made to avoid conflicts at git merge.\n\n## Install\n\nAdd the package to your project as a dev dependency:\n\n    npm install -D changelogify\n\n## Usage\n\n    changelogify [options]\n\n    Options:\n        init          Copy default configuration file into package to be overwriten.\n                            If the user configuration file is not found, default one will be used.\n        add           Write/overwrite the current git branch changelog file \n                            into ./changelogs/unreleased/\n        release       Concat changelogs file from ./changelogs/unreleased/,\n                            add them into ./CHANGELOG.md and delete them.\n\nIf no option is specified, `add` is used. This can be changed or removed to display the helper above, see `defaultCommand` in configuration file.\n\n## Example\n\nThese three changelogs\n\n```json\n{\n  \"message\": \"feature 1\",\n  \"type\": \"Added\",\n  \"branch\": \"7\"\n}\n```\n\n```json\n{\n  \"message\": \"feature 2\",\n  \"type\": \"Added\"\n}\n```\n\n```json\n{\n  \"message\": \"lint\",\n  \"type\": \"Meta\",\n  \"branch\": \"8\"\n}\n```\n\nwill be concatenated into `CHANGELOG.md`\n\n    # Changelog\n\n    All notable changes to this project will be documented in this file.\n\n    The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\n    and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n    ## [v1.0.0] - 2020-1-29\n\n    ### Added\n    - feature 1 - [7](www.example.com/issues/7)\n    - feature 2\n    ### Meta\n    - lint - [8](www.example.com/issues/8)\n\n## Commands\n\n### Init\n\nWith `init`, the default configuration is copied in `./changelogs/config.json`, where you can overwrite it.\n\n```js\n{\n    // changelog types\n    \"types\": [\n        \"Added\",\n        \"Changed\",\n        \"Deprecated\",\n        \"Removed\",\n        \"Fixed\",\n        \"Security\",\n        \"Meta\"\n    ],\n    // link to git issue. `NUMBER` is current branch number by default\n    // if empty, no link will be provided\n    \"gitIssueTemplate\": \"[NUMBER](www.example.com/issues/NUMBER)\",\n    // automatic commit for `add` command\n    \"autoCommitAdd\": true,\n    // associated commit message. `NUMBER` is current branch number by default\n    \"changelogMessageAdd\": \"Add changelog entry for #NUMBER\",\n    // automatic commit for `release` command\n    \"autoCommitRelease\": true,\n    // associated commit message.\n    \"changelogMessageRelease\": \"changelog\",\n    // default command if none is passed (\"\", \"add\", \"init\" or \"release\")\n    \"defaultCommand\": \"add\"\n}\n```\n\nAfter updating the library, you should execute `init`. New settings will be appended, keeping the old ones.\n\nIt also creates the file `./EMPTY_CHANGELOG.md` which you can custom. It will be copied to `./CHANGELOG.md` the first time you use the `release` command.\n\n### Add\n\nThe `add` command ask you to write a changelog entry, choose an entry type and a branch number (optional).\n\nIt will write it in a unique file in `./changelogs/unreleased/`.\n\n```bash\n$ npx changelogify add\n\n\u003e test_changelog@1.0.0 changelog /home/robin/Documents/wanadev/test_changelog\n\u003e node node_modules/changelogify/index.js \"add\"\n\n? What's your changelog entry? Feature 1\n? Entry type? Added\n? What's your git branch number? (Optional) 12\n{\n    \"message\": \"Feature 1\",\n    \"type\": \"Added\",\n    \"branch\": \"12\"\n}\nwritten in /changelogs/unreleased/12-test-changelogify_1.json\n\nChangelog committed, use `git push` to write it remotely\n```\n\nYou can also pass parameters to it.\n\n```bash \n$ npx changelogify add --message \"Feature 1\" --type Added --branch 12\n# or\n$ npx changelogify add -m \"Feature 1\" -t Added -b 12\n```\n\nAnd run it on silent mode.\n\n```bash\n$ npx changelogify add -m \"Feature 1\" -t Added -b 12 -s\n\n\u003e test_changelog@1.0.0 changelog /home/robin/Documents/wanadev/test_changelog\n\u003e node node_modules/changelogify/index.js \"add\" \"-m\" \"Feature 1\" \"-t\" \"Added\" \"-b\" \"12\" \"-s\"\n```\n\n### Release\n\nThe `release` command merge every changelog files from `./changelogs/unreleased/` and add the new content on `./CHANGELOG.md`.\n\nIf `./CHANGELOG.md` doesn't exist, it is created from `./EMPTY_CHANGELOG.md`. Check [init](https://github.com/wanadev/changelogify#init) if you want to use a custom changelog format.\n\n## Changelogs\n\nSee CHANGELOG.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwanadev%2Fchangelogify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwanadev%2Fchangelogify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwanadev%2Fchangelogify/lists"}