{"id":24799243,"url":"https://github.com/hrueger/changelogjs","last_synced_at":"2025-03-24T22:43:25.050Z","repository":{"id":39946226,"uuid":"243671189","full_name":"hrueger/changelogjs","owner":"hrueger","description":"A small customizable changelog generator","archived":false,"fork":false,"pushed_at":"2022-06-25T10:53:04.000Z","size":255,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-26T14:21:57.825Z","etag":null,"topics":["changelog","ci","generator","javascript","script","tool"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/hrueger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"hrueger","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-02-28T03:35:35.000Z","updated_at":"2021-01-12T09:27:35.000Z","dependencies_parsed_at":"2022-09-12T05:40:27.041Z","dependency_job_id":null,"html_url":"https://github.com/hrueger/changelogjs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrueger%2Fchangelogjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrueger%2Fchangelogjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrueger%2Fchangelogjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrueger%2Fchangelogjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hrueger","download_url":"https://codeload.github.com/hrueger/changelogjs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245366196,"owners_count":20603438,"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","ci","generator","javascript","script","tool"],"created_at":"2025-01-30T02:17:33.622Z","updated_at":"2025-03-24T22:43:25.027Z","avatar_url":"https://github.com/hrueger.png","language":"JavaScript","funding_links":["https://github.com/sponsors/hrueger"],"categories":[],"sub_categories":[],"readme":"# ChangelogJS\n\n[![npm](https://img.shields.io/npm/v/@hrueger/changelogjs)](https://npmjs.com/package/@hrueger/changelogjs)\n[![Greenkeeper badge](https://badges.greenkeeper.io/hrueger/changelogjs.svg)](https://greenkeeper.io/)\n[![License](https://img.shields.io/badge/License-MIT-blue)](./LICENSE.md)\n[![GitHub last commit](https://img.shields.io/github/last-commit/hrueger/changelogjs?color=brightgreen)](https://github.com/hrueger/changelogjs/commits)\n[![Maintenance](https://img.shields.io/maintenance/yes/2021)](https://github.com/hrueger/changelogjs/commits)\n\nThis is a small customizable changelog generator.\n\nIt generates the changelog based on **commit messages**, not on release notes.\n\nThe following modes are avalible:\n| HTML | MD | JSON |\n| ---- | -- | ---- |\n| `html-gh` | `md` | `json` |\n| ![Example HTML output](./example_html_output.png) | ![Example Markdown output](./example_md_output.png) | ![Example JSON output](./example_json_output.png) |\n\n## Installation\nType `npm install @hrueger/changelogjs --global` into your terminal.\n\n## Usage\n`changelogjs` without any options. If a `changelogjs.json` file is found in the current folder or above, this is used as the configuration instead of the default values (see below).\n\n## Configuration\nCreate a `changelogjs.json` file ans specify the options below:\n\n| Option | Description | Default |\n| ------ | ----------- | ------- |\n| `title` | The title of the Markdown and HTML page. | `Changelog for your App` |\n| `logoUrl` | The url of a Logo image to be displayed at the top of the HTML page. | Some placeholder image. |\n| `logoAlt` | The alternative text for the logo. | `Logo` |\n| `sort` | A `boolean` value whether the commit messages of one day should be sorted after their type or not. | `true` |\n| `ignoreAuthors` | An `array` of `string` values with authors which should be ignored. | `[\"greenkeeper[bot]\"]` |\n| `headerLinks` | An array of `{url: \"someUrl\", text: \"text to be displayed\", active: false|true}` objects to be displayed as links in the header of the HTML page. | `[{url: \"/\", text: \"Docs\"}, {url: \"#\", text: \"Changelog\", active: true}]` |\n| `footerLinks` | An array of `{url: \"someUrl\", text: \"text to be displayed\"}` objects to be displayed as links in the footer of the HTML page. | `[{url: \"#\", text: \"View on GitHub\"}, {url: \"https://github.com/hrueger/changelogjs\", text: \"Generated by ChangelogJS\"}]` |\n| `modes` | An array of `{mode: \"md\"|\"json\"|\"html-gh\", file: \"someFileName.ext\"}` objects defining which output files with which modes should be generated. See above for the avalible modes. | `[{mode: \"md\", file: \"CHANGELOG.md\"}, {mode: \"json\", file: \"CHANGELOG.json\"}, {mode: \"html-gh\", file: \"CHANGELOG.html\"}]` |\n\n## Contribute\nFeel free to report any issues on GitHub or add new modes / features and create a pull request!\n\n## License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhrueger%2Fchangelogjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhrueger%2Fchangelogjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhrueger%2Fchangelogjs/lists"}