github_bot 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa326810f555e7ef6cab9db0c96d5055cb7251ca156828a846e1a3a98dcc583
-  data.tar.gz: e14ac7aba656ca607cf5c6470f95c336c36d432601cef807bd47d7cf1badc75b
+  metadata.gz: 8171b42a58a7f35cfa98c74f60bb8bed775b5d7fc8b8ff2eb9ee6d4a17c9cb3b
+  data.tar.gz: a0d72d29f3967beb0e22d6b876ffdb8ab57277dcd3f0aa985288c8dab30de272
 SHA512:
-  metadata.gz: e7ac68baca52650e65be184da77495e322dd0eb1a93af76841c2753b3da45f95777955ee3ee6cfc4bed563991a2c1c71fc3b6e02e812c3925f57a626e79f7517
-  data.tar.gz: aff160fd861fce89869963b3f57028d01a373077095c7dae61d8044cdb40e254c3872d3556daee2d1637095f9fbc1fb8cef1641567f73c66240a200222841512
+  metadata.gz: d7509a810213e4700965e54323129bfd04e7a1f52c31f72ce333f4f6dc128001cd4fe910ae3680bf437ad7d072e31a48641e3b44ac818ba104a5e047e6153cab
+  data.tar.gz: c5fbe516cd9401d0f5f567351896a046dd939861731dd0910c9b15d234f6a063ce2e4449db9b04d6193a26a280e765c8646602f7890af043c4822d273b1e61fa

data/.github/workflows/cd.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-        - 2.7
+        - 3.2
     name: Ruby-${{matrix.ruby}}
     steps:
     - name: Check out

data/.github/workflows/ci.yml

@@ -4,11 +4,12 @@ name: CI
 
 on:
   push:
-    branches: ['**']
+    branches: ['main']
   pull_request:
     branches: ['main']
   schedule:
     - cron: '0 1 * * SUN'
+  workflow_dispatch:
 
 jobs:
   tests:
@@ -17,9 +18,9 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-        - 2.6
         - 2.7
         - 3.0
+        - 3.2
     name: Ruby-${{matrix.ruby}}
     continue-on-error: ${{matrix.ruby == 'head'}}
     steps:
@@ -32,6 +33,13 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
       run: bundle install --jobs 4 --retry 3
+    - if: github.event_name == 'pull_request'
+      name: Danger
+      uses: danger/danger-js@9.1.8
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # https://github.com/danger/danger-js/issues/557#issuecomment-664851950
+        DANGER_DISABLE_TRANSPILATION: true
     - name: Run tests
       run: bundle exec rspec
     - name: Run Rubocop

data/.rubocop.yml

@@ -1,19 +1,14 @@
 require:
   - rubocop-performance
-  - rubocop-rspec
-  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
   DisabledByDefault: true
   Exclude:
-    - 'bin/{bundle,bundle-audit,bundler-audit,rake,rspec,rubocop}'
+    - 'bin/{bundle,bundle-audit,bundler-audit,rackup,rake,rspec,rubocop}'
     - 'target/**/*'
     - 'vendor/**/*'
-    - 'build/**/*'
-    - 'pkg/**/*'
-    - 'tmp/**/*'
-    - 'spec/**/*'
+  SuggestExtensions: false
 
 # Bundler Cop Configuration
 # https://docs.rubocop.org/en/stable/cops_bundler/
@@ -241,7 +236,7 @@ Lint/AssignmentInCondition:
   Enabled: true
 Lint/BigDecimalNew:
   Enabled: true
-# Supercedes Lint/UselessComparison in rubocop 0.89.
+# Supersedes Lint/UselessComparison in rubocop 0.89.
 Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
 Lint/BooleanSymbol:
@@ -302,7 +297,7 @@ Lint/MissingCopEnableDirective:
   Enabled: true
 Lint/MissingSuper:
   # Disabled. This cop is well-meaning, but doesn't provide exemption of cases where invocation of
-  # super is not possible. Supercedes Style/MethodMissingSuper in rubocop 0.89.
+  # super is not possible. Supersedes Style/MethodMissingSuper in rubocop 0.89.
     Enabled: false
 Lint/MultipleComparison:
   Enabled: true
@@ -388,8 +383,6 @@ Lint/UselessAccessModifier:
   Enabled: true
 Lint/UselessAssignment:
   Enabled: true
-Lint/UselessElseWithoutRescue:
-  Enabled: true
 Lint/UselessSetterCall:
   Enabled: true
 Lint/Void:
@@ -452,7 +445,7 @@ Naming/MemoizedInstanceVariableName:
   Enabled: true
 Naming/MethodName:
   Enabled: true
-  IgnoredPatterns:
+  AllowedPatterns:
     - 'do_GET'
     - 'do_POST'
     - 'do_PUT'
@@ -468,9 +461,10 @@ Naming/RescuedExceptionsVariableName:
   Enabled: false
 Naming/VariableName:
   Enabled: true
+# Disabled. It's acceptable (and in heavy usage already) to name things like "data_model_1"
+# instead of forcing "data_model1".
 Naming/VariableNumber:
-  Enabled: true
-
+  Enabled: false
 
 # Performance Cop Configuration
 # https://rubocop-performance.readthedocs.io/en/stable/cops_performance/
@@ -605,15 +599,11 @@ Style/DefWithParentheses:
 Style/Dir:
   Enabled: true
 Style/Documentation:
-  Enabled: true
-  Exclude:
-    - test/**/*
-    - spec/**/*
+# Disabled. Documentation is required, but enforcement here does not seem to work.
+  Enabled: false
 Style/DocumentationMethod:
-  Enabled: true
-  Exclude:
-    - test/**/*
-    - spec/**/*
+# Disabled. Documentation is required, but enforcement here does not seem to work.
+  Enabled: false
 Style/DoubleCopDisableDirective:
   Enabled: true
 Style/DoubleNegation:
@@ -659,7 +649,7 @@ Style/GlobalVars:
 Style/GuardClause:
   Enabled: true
 Style/HashSyntax:
-  Enabled: true
+  Enabled: false
 Style/IdenticalConditionalBranches:
   Enabled: true
 Style/IfInsideElse:
@@ -704,7 +694,7 @@ Style/MethodCallWithoutArgsParentheses:
   Enabled: true
 Style/MethodCalledOnDoEndBlock:
 # Disabled. It is acceptable to call a method at the end of a do/end block. In particular, this is
-# occationally needed in RSpec code.
+# occasionally needed in RSpec code.
   Enabled: false
 Style/MethodDefParentheses:
   Enabled: true
@@ -804,7 +794,8 @@ Style/RedundantCondition:
 Style/RedundantConditional:
   Enabled: true
 Style/RedundantException:
-  Enabled: true
+# Disabled.  With ImplicitRuntimeError enabled, disable subsequent warning if consumer wishes to continue using RuntimeError
+  Enabled: false
 Style/RedundantFreeze:
   Enabled: true
 Style/RedundantInterpolation:
@@ -856,8 +847,8 @@ Style/SpecialGlobalVars:
 Style/StabbyLambdaParentheses:
   Enabled: true
 Style/StderrPuts:
-# Disabled. This cop functionally equates use of STDERR with optional warnings. This may be true in some use cases, but there
-#           are times when using STDERR in CLIs is not an optional warning.
+# Disabled. This cop functionally equates use of STDERR with optional warnings. This may be true
+# in some use cases, but there are times when using STDERR in CLIs is not an optional warning.
   Enabled: false
 Style/StringHashKeys:
 # Disabled. There are many use cases where using Strings for Hash keys is required.

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6
+ruby-3.2

data/CHANGELOG.md

@@ -1,2 +1,6 @@
 # 0.1.0
-Initial release
+- Initial release
+
+# 0.3.0
+- Add Danger validation for changelog and prepare for next patch release ([#7](https://github.com/cerner/github_bot-ruby/pull/7))
+- Update to support ruby 3.2 ([#8](https://github.com/cerner/github_bot-ruby/pull/8))

data/Gemfile

@@ -17,7 +17,3 @@ gem 'rubocop-rake', '~> 0.5', require: false
 gem 'rubocop-rspec', '~> 2.1', require: false
 gem 'simplecov', '~> 0.19', require: false
 gem 'timecop', '~> 0.9'
-
-# debugging
-gem 'debase', '~> 0.2.5.beta2'
-gem 'ruby-debug-ide'

data/README.md

@@ -1,6 +1,8 @@
 # GitHub Bot
 
-![CI](https://github.com/cerner/github_bot-ruby/actions/workflows/ci.yml/badge.svg)
+[![Cerner OSS](https://badgen.net/badge/Cerner/OSS/blue)](http://engineering.cerner.com/2014/01/cerner-and-open-source/)
+[![License](https://badgen.net/github/license/cerner/github_bot-ruby)](https://github.com/cerner/github_bot-ruby/blob/main/LICENSE)
+[![Build Status](https://github.com/cerner/github_bot-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/cerner/github_bot-ruby/actions/workflows/ci.yml)
 
 This library is a ruby implementation necessary for beginning your GitHub bot development for Ruby-based projects. The key items this project provides to consumers are the following:
 

data/dangerfile.js

@@ -0,0 +1,97 @@
+const PR_LINK = `([#${danger.github.pr.number}](${danger.github.pr.html_url}))`;
+
+const CHANGELOG_SUMMARY_TITLE = `Instructions and example for changelog`;
+const CHANGELOG_BODY = `Please add an entry to \`CHANGELOG.md\` to the "Unreleased" section. Make sure the entry includes this PR's number.
+
+Example:`;
+
+const CHANGELOG_END_BODY = `If none of the above apply, you can opt out of this check by adding \`#skip-changelog\` to the PR description.`;
+
+function getCleanTitleWithPrLink() {
+  const title = danger.github.pr.title;
+  return title.split(": ").slice(-1)[0].trim().replace(/\.+$/, "") + ` ` + PR_LINK;
+}
+
+function getChangelogDetailsHtml() {
+  return `
+### ${CHANGELOG_SUMMARY_TITLE}
+
+${CHANGELOG_BODY}
+
+\`\`\`markdown
+- ${getCleanTitleWithPrLink()}
+\`\`\`
+
+${CHANGELOG_END_BODY}
+`;
+}
+
+function getChangelogDetailsTxt() {
+  return (
+    CHANGELOG_SUMMARY_TITLE +
+    "\n" +
+    CHANGELOG_BODY +
+    "\n" +
+    getCleanTitleWithPrLink() +
+    "\n" +
+    CHANGELOG_END_BODY
+  );
+}
+
+function HasPermissionToComment() {
+  return (
+    danger.github.pr.head.repo.git_url == danger.github.pr.base.repo.git_url
+  );
+}
+
+async function containsChangelog(path) {
+  const contents = await danger.github.utils.fileContents(path);
+  return contents.includes(PR_LINK);
+}
+
+async function checkChangelog() {
+  const skipChangelog =
+    danger.github && (danger.github.pr.body + "").toLowerCase().includes("#skip-changelog");
+  if (skipChangelog) {
+    return;
+  }
+
+  const hasChangelog = await containsChangelog("CHANGELOG.md");
+
+  if (!hasChangelog) {
+    if (HasPermissionToComment()) {
+      fail("Please consider adding a changelog entry for the next release.");
+      markdown(getChangelogDetailsHtml());
+    } else {
+      //Fallback
+      console.log(
+        "Please consider adding a changelog entry for the next release."
+      );
+      console.log(getChangelogDetailsTxt());
+      process.exitCode = 1;
+    }
+  }
+}
+
+async function checkIfFeature() {
+  const title = danger.github.pr.title;
+  if (title.startsWith("feat:") && HasPermissionToComment()) {
+    message(
+      'Do not forget to update <a href="https://github.com/getsentry/sentry-docs">Sentry-docs</a> with your feature once the pull request gets approved.'
+    );
+  }
+}
+
+async function checkAll() {
+  // See: https://spectrum.chat/danger/javascript/support-for-github-draft-prs~82948576-ce84-40e7-a043-7675e5bf5690
+  const isDraft = danger.github.pr.mergeable_state === "draft";
+
+  if (isDraft) {
+    return;
+  }
+
+  await checkIfFeature();
+  await checkChangelog();
+}
+
+schedule(checkAll);

data/github_bot.gemspec

@@ -27,10 +27,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6.2'
+  # rubocop:disable Gemspec/RequiredRubyVersion
+  # The intent is for supportability from ruby 2.7 and greater
+  spec.required_ruby_version = '>= 2.7.6'
+  # rubocop:enable Gemspec/RequiredRubyVersion
 
   spec.add_dependency 'git', '~> 1.0'
-  spec.add_dependency 'jwt', '~> 1.0'
-  spec.add_dependency 'octokit', '~> 4.18'
+  spec.add_dependency 'jwt', '~> 2.0'
+  spec.add_dependency 'octokit', '>= 4.18'
   spec.add_dependency 'rails', '>= 5.0.0.1', '< 7.0.0'
 end

data/lib/github_bot/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module GithubBot
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 
   # version module
   module Version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_bot
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Greg Howdeshell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -30,26 +30,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.18'
 - !ruby/object:Gem::Dependency
@@ -114,6 +114,7 @@ files:
 - bin/rspec
 - bin/rubocop
 - config/routes.rb
+- dangerfile.js
 - github_bot.gemspec
 - lib/github_bot.rb
 - lib/github_bot/engine.rb
@@ -136,14 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.2
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A rubygem designed to assist in the creation of GitHub bot applications.