danger-changelog 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022eb51f3fa39d8abf589c65dd0c6ebabb20404289c3181447d26417a5ea7a52
-  data.tar.gz: b20da654d12c3cb01061eb4dc329cf9b8cf5f7f83b2736798679fb551334458d
+  metadata.gz: 173f58cbaf43ff80a454e062c19f6674e0742c37fbd59c5bb4e85bc00c8d3899
+  data.tar.gz: 21ac5d08f53444c17cf3231880fc4f45beaca225970ecd1862002909ebbcf8fe
 SHA512:
-  metadata.gz: 4ce70cd1afc862965c8abcf61a6626a29dc726d0a9cd8c6646f4898bde775024e088cb38b1725b88d3481f19cd11efca477094930d5e1442a113344c242ffb9a
-  data.tar.gz: cfae9454953b6fd99ebf1187f74ecaec27d6fd2e44e03c2028c4b7b2632e5a27a0c24bd3fffd7a743bdf3b5dbf4ac96100bb0798ba2c93140fd7a3503fa96a0d
+  metadata.gz: 4e98417f1d4a0d74eeea613d876eca5b39dd5e12337255c08ba3598cde50731fce8533eaddd4b3bde26a20e84baa4674eff409a8b0564f4f539a2f23d0a0534b
+  data.tar.gz: ae509fd46287e51ab6a78ff32fbcfe69ca5c7841abc57f37e6f1a822ddb2d42a627687ca1ea30ff26c7bbbd06c2acb93f431aac3af8d932707c2030ebf73cb4d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### 0.9.1 (Next)
+
+* Your contribution here.
+
+### 0.9.0 (2026/10/14)
+
+* [#72](https://github.com/dblock/danger-changelog/pull/72): Accept bot author links with a `[bot]` suffix without changing their attribution - [@dblock](https://github.com/dblock).
+
 ### 0.8.0 (2025/12/18)
 
 * [#70](https://github.com/dblock/danger-changelog/pull/70): Workflow postreview improvments - [@numbata](https://github.com/numbata).

data/Gemfile

@@ -16,5 +16,6 @@ group :development, :test do
   gem 'rubocop-rake'
   gem 'rubocop-rspec'
   gem 'ruby-grape-danger'
+  gem 'tsort'
   gem 'yard', '~> 0.9.11'
 end

data/doc/intridea.md

@@ -99,9 +99,12 @@ The Intridea style changelog was pioneered on the Hashie project. It has many el
 ```markdown
 * Entry without a PR link - [@ivoanjo](https://github.com/ivoanjo).
 * [#1](https://github.com/dblock/danger-changelog/pull/1): Entry with a PR link - [@dblock](https://github.com/dblock).
+* [#2](https://github.com/dblock/danger-changelog/pull/2): Update dependencies - [@github-actions[bot]](https://github.com/apps/github-actions).
 * Yes, this is a weird entry, but it's still valid! Also Beyoncé is welcome here, as is 松本 行弘 and our nice emojis 👍 - [@ivoanjo](https://github.com/ivoanjo).
 ```
 
+Bot author names may end in a literal `[bot]` suffix, such as `github-actions[bot]` or `dependabot[bot]`. Keep the suffix in the attribution; links to GitHub app pages and bot profiles are supported.
+
 ❌ Entry descriptions need to start with an uppercase A-Z letter
 
 ```markdown

data/lib/changelog/changelog_line/changelog_entry_line.rb

@@ -4,6 +4,9 @@ module Danger
   module Changelog
     # A CHANGELOG.md line represents the change entry.
     class ChangelogEntryLine < ChangelogLine
+      AUTHOR_NAME = /[\w-]+(?:\[bot\])?/.freeze
+      AUTHOR_LINK = %r{\[@#{AUTHOR_NAME}\]\(https://github\.com/.*#{AUTHOR_NAME}\)}.freeze
+
       def valid?
         return validation_result.valid? if validation_result
 
@@ -12,8 +15,8 @@ module Danger
         validation_result.error! 'too many parenthesis' unless balanced?(line)
         return false if validation_result.invalid?
 
-        return true if line =~ %r{^\*\s[`[:upper:]].*[^.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$}
-        return true if line =~ %r{^\*\s\[\#\d+\]\(https://github\.com/.*\d+\): [`[:upper:]].*[^.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$}
+        return true if line =~ /^\*\s[`[:upper:]].*[^.,] - #{AUTHOR_LINK}.$/
+        return true if line =~ %r{^\*\s\[\#\d+\]\(https://github\.com/.*\d+\): [`[:upper:]].*[^.,] - #{AUTHOR_LINK}.$}
 
         validation_result.error! 'does not start with a star' unless ChangelogEntryLine.starts_with_star?(line)
         validation_result.error! 'does not include a pull request link' unless ChangelogEntryLine.with_pr_link?(line)
@@ -22,8 +25,8 @@ module Danger
         validation_result.error! 'has an extra trailing space' if ChangelogEntryLine.ends_with_space?(line)
         validation_result.error! 'is missing a period at the end of the line' unless ChangelogEntryLine.ends_with_period?(line)
         validation_result.error! 'has an extra period or comma at the end of the description' if
-          line =~ %r{^\*\s[`[:upper:]].*[.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$} ||
-          line =~ %r{^\*\s\[\#\d+\]\(https://github\.com/.*\d+\): [`[:upper:]].*[.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$}
+          line =~ /^\*\s[`[:upper:]].*[.,] - #{AUTHOR_LINK}.$/ ||
+          line =~ %r{^\*\s\[\#\d+\]\(https://github\.com/.*\d+\): [`[:upper:]].*[.,] - #{AUTHOR_LINK}.$}
 
         false
       end
@@ -86,7 +89,7 @@ module Danger
 
       # checks whether line contains a MARKDOWN  link to an author
       def self.with_author_link?(line)
-        return true if line =~ %r{\[@[\w\d\-_]+\]\(https?://github\.com/.*[\w\d\-_]+/?\)}
+        return true if line =~ %r{\[@#{AUTHOR_NAME}\]\(https?://github\.com/.*#{AUTHOR_NAME}/?\)}
 
         false
       end

data/lib/changelog/gem_version.rb

@@ -1,3 +1,3 @@
 module Changelog
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/spec/intridea/changelog_entry_line_spec.rb

@@ -113,5 +113,62 @@ describe Danger::Changelog::ChangelogEntryLine do
         expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
       end
     end
+
+    context 'with a bot author' do
+      let(:pr_title) { 'Update dependencies' }
+
+      %w[github-actions[bot] dependabot[bot]].each do |author|
+        it "generates a valid example for #{author}" do
+          allow(github).to receive(:pr_author).and_return(author)
+          example = described_class.example(github)
+          expect(example).to include("[@#{author}](https://github.com/#{author})")
+          expect(described_class.new(example).valid?).to be true
+        end
+      end
+    end
+  end
+
+  context 'with bot attribution' do
+    [
+      '[@github-actions[bot]](https://github.com/apps/github-actions)',
+      '[@dependabot[bot]](https://github.com/dependabot[bot])',
+      '[@renovate[bot]](https://github.com/apps/renovate)'
+    ].each do |author_link|
+      context author_link do
+        [
+          "* Update dependencies - #{author_link}.",
+          "* [#1](https://github.com/dblock/danger-changelog/pull/1): Update dependencies - #{author_link}."
+        ].each do |line|
+          it_behaves_like 'validates as changelog entry line', line
+          it_behaves_like 'valid changelog entry line', line
+        end
+
+        it 'recognizes an author link on its own' do
+          expect(described_class.with_author_link?(author_link)).to be true
+        end
+
+        ['.', ','].each do |punctuation|
+          it "reports an extra #{punctuation} at the end of the description" do
+            entry = described_class.new("* Update dependencies#{punctuation} - #{author_link}.\n")
+            expect(entry.valid?).to be false
+            expect(entry.validation_result.errors)
+              .to include('has an extra period or comma at the end of the description')
+          end
+        end
+
+        it_behaves_like 'invalid changelog entry line', "* Update dependencies - #{author_link}"
+        it_behaves_like 'invalid changelog entry line', "* Update dependencies - #{author_link}. \n"
+        it_behaves_like 'invalid changelog entry line', "* Update dependencies - #{author_link.sub('https:', 'http:')}."
+        it_behaves_like 'invalid changelog entry line', "* Update dependencies - #{author_link.sub('github.com', 'gitlab.com')}."
+      end
+    end
+
+    %w[github-actions[Bot] github-actions[bot]extra github-actions[bot][bot] github-actions[]].each do |author|
+      it "rejects malformed bot suffix in #{author}" do
+        link = "[@#{author}](https://github.com/apps/github-actions)"
+        expect(described_class.with_author_link?(link)).to be false
+        expect(described_class.new("* Update dependencies - #{link}.").valid?).to be false
+      end
+    end
   end
 end

data/spec/intridea/changelog_file_spec.rb

@@ -6,6 +6,15 @@ describe Danger::Changelog::ChangelogFile do
   end
 
   describe 'with the default format checker' do
+    context 'with bot authors' do
+      let(:filename) { File.expand_path('fixtures/bot_authors.md', __dir__) }
+
+      it 'accepts bot entries in a complete changelog' do
+        expect(subject.bad_lines).to eq []
+        expect(subject.global_failures?).to be false
+      end
+    end
+
     context 'minimal example' do
       let(:filename) { File.expand_path('fixtures/minimal.md', __dir__) }
 

data/spec/intridea/fixtures/bot_authors.md

@@ -0,0 +1,5 @@
+### Next
+
+* [#1](https://github.com/dblock/danger-changelog/pull/1): Update dependencies - [@github-actions[bot]](https://github.com/apps/github-actions).
+* Update dependencies - [@dependabot[bot]](https://github.com/dependabot[bot]).
+* Your contribution here.

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - dblock
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -77,6 +78,7 @@ files:
 - spec/intridea/changelog_line_parser_spec.rb
 - spec/intridea/changelog_placeholder_line_spec.rb
 - spec/intridea/changelog_spec.rb
+- spec/intridea/fixtures/bot_authors.md
 - spec/intridea/fixtures/customized.md
 - spec/intridea/fixtures/dates.md
 - spec/intridea/fixtures/extra_trailing_space.md
@@ -100,6 +102,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,7 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: A danger.systems plugin that is OCD about your CHANGELOG.
 test_files: []