danger-changelog 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e13e8dd279d1b68b2703760929b9c2ab4420db154c5420f27c8f6e6a25834719
-  data.tar.gz: a6d5eb4a335dc87df1d586f7f644da0965bb88f7040049797684ac315b3c1ee8
+  metadata.gz: 022eb51f3fa39d8abf589c65dd0c6ebabb20404289c3181447d26417a5ea7a52
+  data.tar.gz: b20da654d12c3cb01061eb4dc329cf9b8cf5f7f83b2736798679fb551334458d
 SHA512:
-  metadata.gz: 7ad171e3366fafab0a20cbf65b5a67e8b77d1fd0d0833f8c45d2668b7e796d51556e939c337ecb08ea67f23462a13902c31034a315102a596747a08e48ef8699
-  data.tar.gz: d191579322f931bbc1e4848cc7c4252c3a5a617a1e3291f9c96d11ceb2171156b487b9879ff5f6631a3de8c44c10b1388dcf2d8b1ce491588cb4248605dc0b7d
+  metadata.gz: 4ce70cd1afc862965c8abcf61a6626a29dc726d0a9cd8c6646f4898bde775024e088cb38b1725b88d3481f19cd11efca477094930d5e1442a113344c242ffb9a
+  data.tar.gz: cfae9454953b6fd99ebf1187f74ecaec27d6fd2e44e03c2028c4b7b2632e5a27a0c24bd3fffd7a743bdf3b5dbf4ac96100bb0798ba2c93140fd7a3503fa96a0d

data/.github/workflows/danger-comment.yml

@@ -0,0 +1,10 @@
+name: Danger Comment
+on:
+  workflow_run:
+    workflows: [Danger]
+    types: [completed]
+
+jobs:
+  comment:
+    uses: ruby-grape/danger/.github/workflows/danger-comment.yml@master
+    secrets: inherit

data/.github/workflows/danger.yml

@@ -2,22 +2,8 @@ name: Danger
 on:
   pull_request:
     types: [ opened, reopened, edited, synchronize ]
+
 jobs:
   danger:
-    name: Danger
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7
-          bundler-cache: true
-      - name: Run Danger
-        run: |
-          # the personal token is public, this is ok, base64 encode to avoid tripping Github
-          TOKEN=$(echo -n Z2hwX0xNQ3VmanBFeTBvYkZVTWh6NVNqVFFBOEUxU25abzBqRUVuaAo= | base64 --decode)
-          DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose
+    uses: ruby-grape/danger/.github/workflows/danger-run.yml@master
+    secrets: inherit

data/.github/workflows/lint.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.3
           bundler-cache: true
       - name: RuboCop
         run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [ '2.7', '3.1', '3.3' ]
+        ruby-version: [ '2.7', '3.1', '3.3', '3.4', 'head' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

data/.rubocop_todo.yml

@@ -51,22 +51,6 @@ RSpec/ContextWording:
 RSpec/ExampleLength:
   Max: 12
 
-# Offense count: 10
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
-# Include: **/*_spec*rb*, **/spec/**/*
-RSpec/FilePath:
-  Exclude:
-    - 'spec/changelog_spec.rb'
-    - 'spec/config_spec.rb'
-    - 'spec/intridea/changelog_entry_line_spec.rb'
-    - 'spec/intridea/changelog_file_spec.rb'
-    - 'spec/intridea/changelog_header_line_spec.rb'
-    - 'spec/intridea/changelog_line_parser_spec.rb'
-    - 'spec/intridea/changelog_placeholder_line_spec.rb'
-    - 'spec/intridea/changelog_spec.rb'
-    - 'spec/keep_a_changelog/changelog_spec.rb'
-    - 'spec/plugin_spec.rb'
-
 # Offense count: 25
 RSpec/MultipleExpectations:
   Max: 8
@@ -103,7 +87,7 @@ RSpec/RepeatedIncludeExample:
     - 'spec/intridea/changelog_entry_line_spec.rb'
     - 'spec/intridea/changelog_header_line_spec.rb'
 
-# Offense count: 10
+# Offense count: 11
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
 # Include: **/*_spec.rb
 RSpec/SpecFilePathFormat:
@@ -119,6 +103,7 @@ RSpec/SpecFilePathFormat:
     - 'spec/intridea/changelog_spec.rb'
     - 'spec/keep_a_changelog/changelog_spec.rb'
     - 'spec/plugin_spec.rb'
+    - 'spec/pr_metadata_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Changelog
 
+### 0.8.0 (2025/12/18)
+
+* [#70](https://github.com/dblock/danger-changelog/pull/70): Workflow postreview improvments - [@numbata](https://github.com/numbata).
+* [#68](https://github.com/dblock/danger-changelog/pull/68): Fix Danger comment workflow artifact download and script core injection - [@numbata](https://github.com/numbata).
+* [#66](https://github.com/dblock/danger-changelog/pull/66): Update danger workflow with tokenless execution and two-workflow pattern - [@numbata](https://github.com/numbata).
+* [#65](https://github.com/dblock/danger-changelog/pull/65): Add support for running changelog checks without GitHub API token - [@numbata](https://github.com/numbata).
+
 ### 0.7.1 (2024/04/12)
 
 * [#63](https://github.com/dblock/danger-changelog/pull/63): Fix: report on lines that start with a - and cannot be parsed - [@dblock](https://github.com/dblock).

data/Dangerfile

@@ -1,4 +1,4 @@
 # danger.systems
 
-toc.check!
-changelog.check!
+# Import ruby-grape-danger for automatic danger report export
+danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

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

data/README.md

@@ -55,7 +55,7 @@ changelog.filename = 'CHANGES.md'
 
 ### changelog.format
 
-Set the format of the CHANGELOG file. 
+Set the format of the CHANGELOG file.
 
 ```ruby
 changelog.format = :keep_a_changelog

data/lib/changelog/gem_version.rb

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

data/lib/changelog/plugin.rb

@@ -96,12 +96,27 @@ module Danger
 
     private
 
+    def pr_metadata
+      Danger::Changelog::PRMetadata.from_event_file(ENV.fetch('GITHUB_EVENT_PATH', nil)) ||
+        Danger::Changelog::PRMetadata.from_github_plugin(github_plugin) ||
+        Danger::Changelog::PRMetadata.fallback
+    end
+
+    def github_plugin
+      github
+    rescue NoMethodError
+      # github plugin is not available in dry_run mode (LocalOnly request source)
+      nil
+    end
+
     def warn_update_changelog
+      example = Danger::Changelog::ChangelogEntryLine.example(pr_metadata)
+
       markdown <<~MARKDOWN
         Here's an example of a #{filename} entry:
 
         ```markdown
-        #{Danger::Changelog::ChangelogEntryLine.example(github)}
+        #{example}
         ```
       MARKDOWN
       warn "Unless you're refactoring existing code or improving documentation, please update #{filename}.", sticky: false

data/lib/changelog/pr_metadata.rb

@@ -0,0 +1,64 @@
+module Danger
+  module Changelog
+    class PRMetadata
+      EXAMPLE_PR_JSON = {
+        'number' => 123,
+        'html_url' => 'https://github.com/org/repo/pull/123'
+      }.freeze
+      EXAMPLE_TITLE = 'Your contribution'.freeze
+      EXAMPLE_AUTHOR = 'username'.freeze
+
+      attr_reader :pr_json, :pr_title, :pr_author
+
+      def initialize(pr_json:, pr_title:, pr_author:)
+        @pr_json = pr_json
+        @pr_title = pr_title
+        @pr_author = pr_author
+      end
+
+      # Attempt to fetch PR metadata from the GitHub plugin.
+      # Returns nil if GitHub API access fails for any reason (authentication, rate limiting, network errors, etc).
+      # This allows the fallback chain to proceed to other sources like GITHUB_EVENT_PATH.
+      def self.from_github_plugin(github = nil)
+        return nil unless github
+
+        begin
+          pr_json = github.pr_json
+          return nil unless pr_json
+
+          new(
+            pr_json: pr_json,
+            pr_title: github.pr_title,
+            pr_author: github.pr_author
+          )
+        rescue Octokit::Error => e
+          warn "[Changelog::PRMetadata] GitHub API request failed (#{e.class}: #{e.message}). Falling back to other PR metadata sources."
+          nil
+        end
+      end
+
+      def self.from_event_file(path)
+        return nil unless path
+        return nil unless File.exist?(path)
+
+        event = JSON.parse(File.read(path))
+        pr = event['pull_request']
+        return nil unless pr
+
+        new(
+          pr_json: pr,
+          pr_title: pr['title'],
+          pr_author: pr.dig('user', 'login')
+        )
+      end
+
+      def self.fallback
+        new(
+          pr_json: EXAMPLE_PR_JSON,
+          pr_title: EXAMPLE_TITLE,
+          pr_author: EXAMPLE_AUTHOR
+        )
+      end
+    end
+  end
+end

data/lib/danger_plugin.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'changelog/changelog_line/changelog_entry_line'
 require 'changelog/changelog_line/changelog_header_line'
 require 'changelog/changelog_line/changelog_line_parser'
@@ -6,4 +7,5 @@ require 'changelog/changelog_line/changelog_line'
 require 'changelog/changelog_file'
 require 'changelog/parsers'
 require 'changelog/config'
+require 'changelog/pr_metadata'
 require 'changelog/plugin'

data/spec/changelog_spec.rb

@@ -31,7 +31,8 @@ describe Danger::Changelog do
           expect(subject).to be false
           expect(status_report[:errors]).to eq []
           expect(status_report[:warnings]).to eq ["Unless you're refactoring existing code or improving documentation, please update CHANGELOG.md."]
-          expect(status_report[:markdowns].map(&:message)).to eq ["Here's an example of a CHANGELOG.md entry:\n\n```markdown\n* [#123](https://github.com/dblock/danger-changelog/pull/123): Being dangerous - [@dblock](https://github.com/dblock).\n```\n"]
+          expect(status_report[:markdowns].map(&:message).first).to include("Here's an example of a CHANGELOG.md entry:")
+          expect(status_report[:markdowns].map(&:message).first).to match(%r{\* \[#\d+\]\(https://github\.com/.+/pull/\d+\): .+ - \[@.+\]\(https://github\.com/.+\)\.})
         end
       end
 
@@ -64,7 +65,8 @@ describe Danger::Changelog do
             expect(subject).to be false
             expect(status_report[:errors]).to eq []
             expect(status_report[:warnings]).to eq ["Unless you're refactoring existing code or improving documentation, please update #{changelog.filename}."]
-            expect(status_report[:markdowns].map(&:message)).to eq ["Here's an example of a #{changelog.filename} entry:\n\n```markdown\n* [#123](https://github.com/dblock/danger-changelog/pull/123): Being dangerous - [@dblock](https://github.com/dblock).\n```\n"]
+            expect(status_report[:markdowns].map(&:message).first).to include("Here's an example of a #{changelog.filename} entry:")
+            expect(status_report[:markdowns].map(&:message).first).to match(%r{\* \[#\d+\]\(https://github\.com/.+/pull/\d+\): .+ - \[@.+\]\(https://github\.com/.+\)\.})
           end
         end
 

data/spec/pr_metadata_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Danger::Changelog::PRMetadata do
+  describe '.from_github_plugin' do
+    context 'when github is nil' do
+      it 'returns nil' do
+        expect(described_class.from_github_plugin(nil)).to be_nil
+      end
+    end
+
+    context 'when github has no pr_json' do
+      let(:github) { instance_double(Danger::DangerfileGitHubPlugin, pr_json: nil) }
+
+      it 'returns nil' do
+        expect(described_class.from_github_plugin(github)).to be_nil
+      end
+    end
+
+    context 'when github has pr_json' do
+      subject(:metadata) { described_class.from_github_plugin(github) }
+
+      let(:github) do
+        instance_double(
+          Danger::DangerfileGitHubPlugin,
+          pr_json: { 'number' => 123, 'html_url' => 'https://github.com/org/repo/pull/123' },
+          pr_title: 'Add feature',
+          pr_author: 'dblock'
+        )
+      end
+
+      it 'creates metadata from github plugin' do
+        expect(metadata.pr_json).to eq('number' => 123, 'html_url' => 'https://github.com/org/repo/pull/123')
+        expect(metadata.pr_title).to eq 'Add feature'
+        expect(metadata.pr_author).to eq 'dblock'
+      end
+    end
+
+    context 'when github plugin raises Octokit::Error' do
+      let(:github) do
+        instance_double(Danger::DangerfileGitHubPlugin)
+      end
+
+      [Octokit::Unauthorized, Octokit::TooManyRequests, Octokit::Forbidden].each do |error_class|
+        context "with #{error_class}" do
+          before do
+            allow(github).to receive(:pr_json).and_raise(error_class.new)
+          end
+
+          it 'returns nil to allow fallback' do
+            expect(described_class.from_github_plugin(github)).to be_nil
+          end
+        end
+      end
+    end
+  end
+
+  describe '.from_event_file' do
+    context 'when path is nil' do
+      it 'returns nil' do
+        expect(described_class.from_event_file(nil)).to be_nil
+      end
+    end
+
+    context 'when file does not exist' do
+      it 'returns nil' do
+        expect(described_class.from_event_file('/nonexistent/path.json')).to be_nil
+      end
+    end
+
+    context 'when file contains pull_request event' do
+      subject(:metadata) { described_class.from_event_file(event_file.path) }
+
+      let(:event_file) { Tempfile.new(['github_event', '.json']) }
+      let(:event_data) do
+        {
+          'pull_request' => {
+            'number' => 456,
+            'html_url' => 'https://github.com/org/repo/pull/456',
+            'title' => 'Fix bug',
+            'user' => { 'login' => 'contributor' }
+          }
+        }
+      end
+
+      before do
+        event_file.write(JSON.generate(event_data))
+        event_file.close
+      end
+
+      after { event_file.unlink }
+
+      it 'creates metadata from event file' do
+        expect(metadata.pr_json).to eq event_data['pull_request']
+        expect(metadata.pr_title).to eq 'Fix bug'
+        expect(metadata.pr_author).to eq 'contributor'
+      end
+    end
+
+    context 'when file contains non-PR event' do
+      let(:event_file) { Tempfile.new(['github_event', '.json']) }
+      let(:event_data) { { 'push' => { 'ref' => 'refs/heads/main' } } }
+
+      before do
+        event_file.write(JSON.generate(event_data))
+        event_file.close
+      end
+
+      after { event_file.unlink }
+
+      it 'returns nil' do
+        expect(described_class.from_event_file(event_file.path)).to be_nil
+      end
+    end
+  end
+
+  describe '.fallback' do
+    subject(:metadata) { described_class.fallback }
+
+    it 'returns metadata with example values' do
+      expect(metadata.pr_json).to eq('number' => 123, 'html_url' => 'https://github.com/org/repo/pull/123')
+      expect(metadata.pr_title).to eq 'Your contribution'
+      expect(metadata.pr_author).to eq 'username'
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - dblock
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -31,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/danger-comment.yml"
 - ".github/workflows/danger.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
@@ -66,6 +66,7 @@ files:
 - lib/changelog/parsers/keep_a_changelog.rb
 - lib/changelog/parsers/validation_result.rb
 - lib/changelog/plugin.rb
+- lib/changelog/pr_metadata.rb
 - lib/danger_changelog.rb
 - lib/danger_plugin.rb
 - spec/changelog_spec.rb
@@ -91,6 +92,7 @@ files:
 - spec/keep_a_changelog/fixtures/lines_with_links.md
 - spec/keep_a_changelog/fixtures/missing_a_version_header.md
 - spec/plugin_spec.rb
+- spec/pr_metadata_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/changelog.rb
 homepage: https://github.com/dblock/danger-changelog
@@ -98,7 +100,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A danger.systems plugin that is OCD about your CHANGELOG.
 test_files: []