{"id":13684159,"url":"https://github.com/dblock/danger-changelog","last_synced_at":"2025-04-09T14:10:19.374Z","repository":{"id":45891597,"uuid":"66667678","full_name":"dblock/danger-changelog","owner":"dblock","description":"A plugin that is OCD about your CHANGELOG format.","archived":false,"fork":false,"pushed_at":"2024-04-12T18:29:14.000Z","size":239,"stargazers_count":30,"open_issues_count":16,"forks_count":15,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T08:48:57.744Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/dblock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2016-08-26T17:46:08.000Z","updated_at":"2025-03-12T21:26:39.000Z","dependencies_parsed_at":"2024-01-14T16:08:01.535Z","dependency_job_id":"6f760ccc-8328-4cf9-b2fb-dca30aae866a","html_url":"https://github.com/dblock/danger-changelog","commit_stats":{"total_commits":66,"total_committers":7,"mean_commits":9.428571428571429,"dds":"0.25757575757575757","last_synced_commit":"b82fb46fa1f618f82851912f0a6ea61a11cc2b21"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fdanger-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fdanger-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fdanger-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fdanger-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dblock","download_url":"https://codeload.github.com/dblock/danger-changelog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054194,"owners_count":21039952,"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":[],"created_at":"2024-08-02T14:00:28.324Z","updated_at":"2025-04-09T14:10:19.341Z","avatar_url":"https://github.com/dblock.png","language":"Ruby","funding_links":[],"categories":["Plugins"],"sub_categories":["Ruby (danger)"],"readme":"# Danger-Changelog\n\nA plugin for [danger.systems](http://danger.systems) that obsessive-compulsively lints your project’s `CHANGELOG.md`.\nIt can make sure, for example, that changes are attributed properly, have a valid version number, a date in the ISO8601 format, balanced parenthesis and brackets, and that they’re always terminated with a period.\n\n[![Gem Version](https://badge.fury.io/rb/danger-changelog.svg)](https://badge.fury.io/rb/danger-changelog)\n[![Build Status](https://github.com/dblock/danger-changelog/actions/workflows/test.yml/badge.svg?branch=master\u0026event=push)](https://github.com/dblock/danger-changelog/actions/workflows/test.yml)\n\n# Table of Contents\n\n- [What’s a correctly formatted CHANGELOG file?](#whats-a-correctly-formatted-changelog-file)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Configuration](#configuration)\n  - [changelog.filename](#changelogfilename)\n  - [changelog.format](#changelogformat)\n  - [changelog.placeholder_line](#changelogplaceholder_line)\n  - [changelog.ignore_files](#changelogignore_files)\n- [Checks](#checks)\n  - [changelog.check!](#changelogcheck)\n    - [changelog.have_you_updated_changelog?](#changeloghave_you_updated_changelog)\n    - [changelog.is_changelog_format_correct?](#changelogis_changelog_format_correct)\n- [Contributing](#contributing)\n- [Copyright](#copyright)\n\n## What's a correctly formatted CHANGELOG file?\n\nBy design, `danger-changelog` is quite strict with what it allows as a valid changelog file, using the [Intridea style](doc/intridea.md), [used by this library itself](CHANGELOG.md). It also supports the [Keep a Changelog](doc/keep_a_changelog.md) format.\n\n## Installation\n\nAdd `danger-changelog` to your Gemfile.\n\n```\ngem 'danger-changelog', '~\u003e 0.6.0'\n```\n\nCall `changelog.check!` from your `Dangerfile`. Make a pull request and see this plugin in action.\n\n## Usage\n\nMethods and attributes from this plugin are available in your `Dangerfile` under the `changelog` namespace.\n\n## Configuration\n\nThe following options and checks are supported.\n\n### changelog.filename\n\nSet the CHANGELOG file name, defaults to `CHANGELOG.md`.\n\n```ruby\nchangelog.filename = 'CHANGES.md'\n```\n\n### changelog.format\n\nSet the format of the CHANGELOG file. \n\n```ruby\nchangelog.format = :keep_a_changelog\n```\n\nAvailable formats are [Intridea](doc/intridea.md) (default) and [Keep a Changelog](doc/keep_a_changelog.md).\n\n### changelog.placeholder_line\n\nCustomize the `* Your contribution here.` line. Set the value to `nil` to stop checking for one.\n\n```ruby\nchangelog.placeholder_line = \"* Your change here.\\n\"\n```\n\n### changelog.ignore_files\n\nIgnore additions and changes with a certain name or expression, default is to ignore `README.md` changes.\n\nFor example, ignore `UPGRADING.md` and all `.txt` files.\n\n```ruby\nchangelog.ignore_files = ['README.md', 'UPGRADING.md', /\\.txt$/]\n```\n\n## Checks\n\nInvoke check methods.\n\n### changelog.check!\n\nRun all checks with defaults, including `have_you_updated_changelog?` and `is_changelog_format_correct?`.\n\n#### changelog.have_you_updated_changelog?\n\nChecks whether you have updated CHANGELOG.md.\n\n![](images/have_you_updated_changelog.png)\n\n#### changelog.is_changelog_format_correct?\n\nChecks whether the CHANGELOG format is correct.\n\n![](images/is_changelog_format_correct.png)\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md).\n\n## Copyright\n\nCopyright (c) Daniel Doubrovkine, 2016-2019\n\nMIT License, see [LICENSE](LICENSE.txt) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdblock%2Fdanger-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdblock%2Fdanger-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdblock%2Fdanger-changelog/lists"}