Extract yard

Author: TonyCTHsu

.github/workflows/yard.yml

@@ -25,15 +25,18 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/datadog/images-rb/engines/ruby:3.2
+      env:
+        BUNDLE_GEMFILE: tools/yard.gemfile
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.2'
-          bundler-cache: true
+      - run: ls -al
+      - name: Bundle
+        run: bundle install
       - name: Generate YARD documentation
-        run: bundle exec rake docs
+        run: bundle exec rake docs --rakefile=tasks/yard.rake
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

Gemfile

@@ -51,8 +51,6 @@ elsif RUBY_VERSION >= '3.0.0' # No longer bundled by default since Ruby 3.0
   gem 'webrick', '>= 1.7.0'
 end
 
-gem 'yard', '~> 0.9' # NOTE: YardDoc is generated with ruby 3.2 in GitHub Actions
-
 if RUBY_VERSION >= '2.6.0'
   # 1.50 is the last version to support Ruby 2.6
   gem 'rubocop', '~> 1.50.0', require: false

Rakefile

@@ -4,7 +4,6 @@ require 'rubocop/rake_task' if Gem.loaded_specs.key? 'rubocop'
 require 'standard/rake' if Gem.loaded_specs.key? 'standard'
 require 'rspec/core/rake_task'
 require 'rake/extensiontask'
-require 'yard'
 require 'os'
 if Gem.loaded_specs.key? 'ruby_memcheck'
   require 'ruby_memcheck'
@@ -350,17 +349,6 @@ if defined?(RuboCop::RakeTask)
   end
 end
 
-YARD::Rake::YardocTask.new(:docs) do |t|
-  # Options defined in `.yardopts` are read first, then merged with
-  # options defined here.
-  #
-  # It's recommended to define options in `.yardopts` instead of here,
-  # as `.yardopts` can be read by external YARD tools, like the
-  # hot-reload YARD server `yard server --reload`.
-
-  t.options += ['--title', "datadog #{Datadog::VERSION::STRING} documentation"]
-end
-
 # Jobs are parallelized if running in CI.
 desc 'CI task; it runs all tests for current version of Ruby'
 task ci: 'test:all'

tasks/yard.rake

@@ -0,0 +1,18 @@
+
+if Gem.loaded_specs["yard"]
+  require 'yard'
+else
+  warn "'yard' gem not loaded: skipping tasks..." if Rake.verbose == true
+  return
+end
+
+YARD::Rake::YardocTask.new(:docs) do |t|
+  # Options defined in `.yardopts` are read first, then merged with
+  # options defined here.
+  #
+  # It's recommended to define options in `.yardopts` instead of here,
+  # as `.yardopts` can be read by external YARD tools, like the
+  # hot-reload YARD server `yard server --reload`.
+
+  t.options += ['--title', "datadog #{Datadog::VERSION::STRING} documentation"]
+end

tools/yard.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rake'
+gem 'yard'
+gem 'redcarpet'