{"id":17697497,"url":"https://github.com/wiiznokes/changen","last_synced_at":"2026-01-08T18:49:33.938Z","repository":{"id":251754052,"uuid":"836456445","full_name":"wiiznokes/changen","owner":"wiiznokes","description":"Feature-rich changelog generator","archived":false,"fork":false,"pushed_at":"2024-10-01T23:21:42.000Z","size":173,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-07T17:15:37.806Z","etag":null,"topics":["changelog","gen","release-notes"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/wiiznokes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["wiiznokes"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://www.paypal.com/donate/?hosted_button_id=HV84HZ4G63HQ6"]}},"created_at":"2024-07-31T22:28:01.000Z","updated_at":"2024-09-05T02:21:34.000Z","dependencies_parsed_at":"2024-08-12T18:36:57.800Z","dependency_job_id":"275793b2-e829-4eeb-b68a-05a238431ad0","html_url":"https://github.com/wiiznokes/changen","commit_stats":null,"previous_names":["wiiznokes/changelog","wiiznokes/changelog-generator","wiiznokes/changen"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiiznokes%2Fchangen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiiznokes%2Fchangen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiiznokes%2Fchangen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiiznokes%2Fchangen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wiiznokes","download_url":"https://codeload.github.com/wiiznokes/changen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243318767,"owners_count":20272136,"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":["changelog","gen","release-notes"],"created_at":"2024-10-24T14:47:43.619Z","updated_at":"2026-01-08T18:49:28.904Z","avatar_url":"https://github.com/wiiznokes.png","language":"Rust","funding_links":["https://github.com/sponsors/wiiznokes","https://www.paypal.com/donate/?hosted_button_id=HV84HZ4G63HQ6"],"categories":[],"sub_categories":[],"readme":"# Changelog generator\n\n## Features\n\n- feature-rich changelog format\n- low-config changelog management\n- customizable\n\n## See in action\n\nThis project use `changen` to maintain its changelog, using github action\n\n- [The changelog file](./CHANGELOG.md) - see what the syntax have to offer\n- [Its commits history](https://github.com/wiiznokes/changen/commits/master/CHANGELOG.md)\n- [The release Github workflow](./.github/workflows/create_release_notes_pr.yml) - It will create a PR\n\n## Getting started\n\n1. **Create the changelog**\n\n   If you don't have a changelog file yet, you can use `changen new`.\n\n2. **Validate your changelog syntax**\n\n   If you already have a changelog file, you can see if its syntax get accepted by running `changen validate`.\n\n3. **Generate release notes**\n\n   When you know your changelog is valid, you can use `changen generate` to generate a release-note about the last commit.\n\n   It can generate release notes\n\n   - between two tags/commits\n   - for a specific commit/tag\n   - for a milestone\n\n   By default, it will generate release notes from the last release in the changelog to HEAD. It will get the list of commits using a `git log` command, and try to match them against remote PRs if it have the necessary infos.\n\n4. **Make a new release**\n\n   To make a new release, use `changen release --version 1.0.0`.\n\n**The full API reference can be found [here](./res/API_REFERENCE.md)** (automatically generated).\n\n## Commit syntax\n\n```\nfix(project_a): Fix a nasty bug \u003c=\u003e commit-type(scope): commit-message\n```\n\n## Advanced use\n\n#### Ignore commit\n\nCurrently, you can write theses patterns anywhere in the commit message:\n\n- `(skip changelog)`\n- `(ignore changelog)`\n- `!changelog`\n- `!log`\n\n#### Map commit type to section(ex: `### Fixed`) in the changelog\n\nThe default map can be seen [here](./res/map_commit_type_to_section.json). Note than the order will define in witch order the section will appears in the log file.\nUse with `changen generate --map path/to/map.json`\n\n#### Changelog custom path\n\n`changen generate --file path/to/CHANGELOG.md`\n\n## Acknowledgement\n\n- [pom](https://github.com/J-F-Liu/pom) for being an awesome parser. Without this parser, i would have probably drop this project! The [parser](./changelog_document/src/de.rs) of the changelog is less than 200 lines!\n\n- Iced, for its well maintained [changelog](https://github.com/iced-rs/iced/blob/master/CHANGELOG.md)\n\n- [Gitoxide changelog](https://github.com/Byron/gitoxide/blob/main/CHANGELOG.md) because its use a [similar tool](https://github.com/Byron/cargo-smart-release) (quit complex and more powerful)\n- [clap](https://github.com/clap-rs/clap)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiiznokes%2Fchangen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwiiznokes%2Fchangen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiiznokes%2Fchangen/lists"}