Avoid duplicate build folder in @primer/octicons (#1010)

* Avoid duplicate build folder in @primer/octicons * Update year to 2024 in LICENSE files * Upgrade to newer artifact upload/download actions * Use newer ruby for linting * Upgrade rubocop version * Upgrade rubocop in more places * Disable checksum verification (since we're building the gem ourselves) * Fix bad class variable access pattern --------- Co-authored-by: Federico Brigante <me@fregante.com>
primer · Mar 12, 2024 · 062778c · 062778c
1 parent 6bc78de
commit 062778c
Show file tree

Hide file tree

Showing 38 changed files with 103 additions and 47 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
       - name: Building
         run: yarn build
       - run: cp -r icons lib/build/svg
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: octicons-build
           path: ./lib/build
@@ -31,7 +31,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: octicons-build
           path: ./lib/build
@@ -53,7 +53,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: octicons-build
           path: ./lib/build
@@ -77,7 +77,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: octicons-build
           path: ./lib/build
@@ -101,8 +101,8 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
-      - uses: actions/download-artifact@v3
+          ruby-version: 3.3
+      - uses: actions/download-artifact@v4
         with:
           name: octicons-build
           path: ./lib/octicons_gem/lib/build
@@ -113,7 +113,7 @@ jobs:
         run: bundle exec rake test
       - name: Build
         run: bundle exec rake build
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: octicons-gem
           path: ./lib/octicons_gem/pkg
@@ -130,12 +130,13 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
-      - uses: actions/download-artifact@v3
+          ruby-version: 3.3
+      - uses: actions/download-artifact@v4
         with:
           name: octicons-gem
           path: ./lib/octicons_helper/vendor/cache
-      - run: bundle install
+      - name: Run bundle install
+        run: bundle config set --local disable_checksum_validation true && bundle install
       - name: Linting
         run: bundle exec rake lint
       - name: Testing
@@ -153,12 +154,13 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
-      - uses: actions/download-artifact@v3
+          ruby-version: 3.3
+      - uses: actions/download-artifact@v4
         with:
           name: octicons-gem
           path: ./lib/octicons_jekyll/vendor/cache
-      - run: bundle install
+      - name: Run bundle install
+        run: bundle config set --local disable_checksum_validation true && bundle install
       - name: Linting
         run: bundle exec rake lint
       - name: Testing

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -14,7 +14,7 @@ jobs:
       - run: npm install
       - run: npm run build
       - run: cp -r icons lib/build/svg
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: octicons
           path: ./lib/build
@@ -23,7 +23,7 @@ jobs:
     needs: setup
     steps:
       - uses: actions/checkout@master
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons
           path: ./lib/build
@@ -33,7 +33,7 @@ jobs:
         with:
           args: octicons_gem
       - run: ls ./lib/octicons_gem/pkg
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: octicons_gem
           path: ./lib/octicons_gem/pkg
@@ -42,11 +42,11 @@ jobs:
     needs: gem
     steps:
       - uses: actions/checkout@master
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons
           path: ./lib/build
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons_gem
           path: ./lib/octicons_helper/vendor/cache
@@ -60,11 +60,11 @@ jobs:
     needs: gem
     steps:
       - uses: actions/checkout@master
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons
           path: ./lib/build
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons_gem
           path: ./lib/octicons_jekyll/vendor/cache
@@ -78,7 +78,7 @@ jobs:
     needs: setup
     steps:
       - uses: actions/checkout@master
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons
           path: ./lib/build
@@ -92,7 +92,7 @@ jobs:
     needs: setup
     steps:
       - uses: actions/checkout@master
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: octicons
           path: ./lib/build

diff --git a/.rubocop.yml b/.rubocop.yml
@@ -2,3 +2,6 @@ inherit_gem:
   rubocop-github:
     - config/default.yml
     - config/rails.yml
+
+AllCops:
+  NewCops: enable
diff --git a/Gemfile b/Gemfile
@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 group :development, :test do
   gem "minitest"
   gem "rake"
-  gem "rubocop", "0.59"
-  gem "rubocop-github", "0.12.0"
+  gem "rubocop-github", "0.20.0"
 end
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 GitHub Inc.
+Copyright (c) 2024 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/lib/octicons_gem/Gemfile b/lib/octicons_gem/Gemfile
@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
 group :development, :test do
   gem "minitest"
   gem "rake"
-  gem "rubocop", "0.59"
-  gem "rubocop-github", "0.12.0"
+  gem "rubocop-github", "0.20.0"
 end
diff --git a/lib/octicons_gem/LICENSE b/lib/octicons_gem/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 GitHub Inc.
+Copyright (c) 2024 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/lib/octicons_gem/Rakefile b/lib/octicons_gem/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake/testtask"
 require "rubocop/rake_task"
 require "bundler/gem_tasks"

diff --git a/lib/octicons_gem/lib/octicons.rb b/lib/octicons_gem/lib/octicons.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "octicons/version"
 require "octicons/octicon"
 require "json"

diff --git a/lib/octicons_gem/lib/octicons/octicon.rb b/lib/octicons_gem/lib/octicons/octicon.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Octicons
   class Octicon
     DEFAULT_HEIGHT = 16

diff --git a/lib/octicons_gem/lib/octicons/version.rb b/lib/octicons_gem/lib/octicons/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Octicons
   VERSION = "19.8.0".freeze
 end
diff --git a/lib/octicons_gem/octicons.gemspec b/lib/octicons_gem/octicons.gemspec
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../lib/octicons/version", __FILE__)
 
 Gem::Specification.new do |s|

diff --git a/lib/octicons_gem/test/helper.rb b/lib/octicons_gem/test/helper.rb
@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "minitest/autorun"
 require "octicons"
 
 def octicon(symbol, options = {})
-  ::Octicons::Octicon.new(symbol, options)
+  Octicons::Octicon.new(symbol, options)
 end
diff --git a/lib/octicons_gem/test/octicon_test.rb b/lib/octicons_gem/test/octicon_test.rb
@@ -1,4 +1,6 @@
-require_relative "./helper"
+# frozen_string_literal: true
+
+require_relative "helper"
 
 describe Octicons::Octicon do
   it "fails when the octicon doesn't exist" do

diff --git a/lib/octicons_gem/test/octicons_test.rb b/lib/octicons_gem/test/octicons_test.rb
@@ -1,4 +1,6 @@
-require_relative "./helper"
+# frozen_string_literal: true
+
+require_relative "helper"
 
 describe Octicons do
   it "loads all icons on initialization" do

diff --git a/lib/octicons_helper/Gemfile b/lib/octicons_helper/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
@@ -8,6 +10,5 @@ gem "rails"
 group :development, :test do
   gem "minitest"
   gem "rake"
-  gem "rubocop", "0.59"
-  gem "rubocop-github", "0.12.0"
+  gem "rubocop-github", "0.20.0"
 end
diff --git a/lib/octicons_helper/LICENSE b/lib/octicons_helper/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 GitHub Inc.
+Copyright (c) 2024 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/lib/octicons_helper/Rakefile b/lib/octicons_helper/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake/testtask"
 require "rubocop/rake_task"
 require "bundler/gem_tasks"

diff --git a/lib/octicons_helper/lib/octicons_helper.rb b/lib/octicons_helper/lib/octicons_helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "octicons_helper/version"
 require "octicons_helper/helper"
 require "octicons_helper/railtie" if defined?(Rails)
diff --git a/lib/octicons_helper/lib/octicons_helper/helper.rb b/lib/octicons_helper/lib/octicons_helper/helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "octicons"
 require "action_view"
 

diff --git a/lib/octicons_helper/lib/octicons_helper/railtie.rb b/lib/octicons_helper/lib/octicons_helper/railtie.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails"
 
 module OcticonsHelper

diff --git a/lib/octicons_helper/lib/octicons_helper/version.rb b/lib/octicons_helper/lib/octicons_helper/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OcticonsHelper
   VERSION = "19.8.0".freeze
 end
diff --git a/lib/octicons_helper/octicons_helper.gemspec b/lib/octicons_helper/octicons_helper.gemspec
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../lib/octicons_helper/version", __FILE__)
 
 Gem::Specification.new do |s|

diff --git a/lib/octicons_helper/test/helper.rb b/lib/octicons_helper/test/helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "minitest/autorun"
 require "octicons_helper"
 

diff --git a/lib/octicons_helper/test/octicons_helper_test.rb b/lib/octicons_helper/test/octicons_helper_test.rb
@@ -1,4 +1,6 @@
-require_relative "./helper"
+# frozen_string_literal: true
+
+require_relative "helper"
 
 describe OcticonsHelper do
   describe "rendering" do
@@ -23,10 +25,10 @@
 
       mock = Minitest::Mock.new
       def mock.path
-        @@call_count ||= 0
-        @@call_count += 1
+        @call_count ||= 0
+        @call_count += 1
 
-        raise "Octicon library called twice" if @@call_count > 1
+        raise "Octicon library called twice" if @call_count > 1
 
         "foo"
       end

diff --git a/lib/octicons_jekyll/.rubocop.yml b/lib/octicons_jekyll/.rubocop.yml
@@ -4,3 +4,6 @@ inherit_gem:
 
 Naming/FileName:
   Enabled: false
+
+AllCops:
+  NewCops: enable
diff --git a/lib/octicons_jekyll/Gemfile b/lib/octicons_jekyll/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
@@ -7,6 +9,5 @@ gem "octicons", "19.8.0"
 group :development, :test do
   gem "minitest"
   gem "rake"
-  gem "rubocop", "0.59"
-  gem "rubocop-github", "0.12.0"
+  gem "rubocop-github", "0.20.0"
 end
diff --git a/lib/octicons_jekyll/LICENSE b/lib/octicons_jekyll/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 GitHub Inc.
+Copyright (c) 2024 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/lib/octicons_jekyll/Rakefile b/lib/octicons_jekyll/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake/testtask"
 require "rubocop/rake_task"
 require "bundler/gem_tasks"
@@ -6,7 +8,7 @@ RuboCop::RakeTask.new(:lint) do |t|
   t.options = ["--display-cop-names"]
 end
 
-task :version, [:v] do |t, args|
+task :version, [:v] => :environment do |t, args|
   out = "# Prevent bundler errors\n"\
   "module Liquid; class Tag; end; end\n\n"\
   "module Jekyll\n"\