diff --git a/.github/workflows/yard.yml b/.github/workflows/yard.yml index 70185f8a092..dea8de5f03f 100644 --- a/.github/workflows/yard.yml +++ b/.github/workflows/yard.yml @@ -2,7 +2,7 @@ name: Deploy Yard documentation to Pages on: push: - branches: ["release"] + branches: ["release", "tonycthsu/fix-yard"] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -21,26 +21,30 @@ concurrency: jobs: deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} + # environment: + # 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 - - name: Setup Pages - uses: actions/configure-pages@v3 - - name: Upload artifact - uses: actions/upload-pages-artifact@v1 - with: - # Upload generated YARD directory - path: 'doc/' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v2 + - run: ls -al doc + # - name: Setup Pages + # uses: actions/configure-pages@v3 + # - name: Upload artifact + # uses: actions/upload-pages-artifact@v1 + # with: + # # Upload generated YARD directory + # path: 'doc/' + # - name: Deploy to GitHub Pages + # id: deployment + # uses: actions/deploy-pages@v2 diff --git a/Gemfile b/Gemfile index fae3a17685a..38384131c01 100644 --- a/Gemfile +++ b/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 diff --git a/tools/yard.gemfile b/tools/yard.gemfile new file mode 100644 index 00000000000..6ba8b33993c --- /dev/null +++ b/tools/yard.gemfile @@ -0,0 +1,4 @@ +eval_gemfile "../Gemfile" + +gem 'yard' +gem 'redcarpet' diff --git a/tools/yard.gemfile.lock b/tools/yard.gemfile.lock new file mode 100644 index 00000000000..016a558f07d --- /dev/null +++ b/tools/yard.gemfile.lock @@ -0,0 +1,253 @@ +GIT + remote: https://github.com/DataDog/simplecov + revision: 3bb6b7ee58bf4b1954ca205f50dd44d6f41c57db + ref: 3bb6b7ee58bf4b1954ca205f50dd44d6f41c57db + specs: + simplecov (0.21.2) + docile (~> 1.1) + simplecov-html (~> 0.11) + simplecov_json_formatter (~> 0.1) + +PATH + remote: .. + specs: + datadog (2.3.0) + debase-ruby_core_source (= 3.3.1) + libdatadog (~> 12.0.0.1.0) + libddwaf (~> 1.14.0.0.0) + msgpack + +GEM + remote: https://rubygems.org/ + specs: + activesupport (7.2.1) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + appraisal (2.4.1) + bundler + rake + thor (>= 0.14.0) + ast (2.4.2) + base64 (0.2.0) + benchmark-ips (2.14.0) + benchmark-memory (0.1.2) + memory_profiler (~> 0.9) + bigdecimal (3.1.8) + binding_of_caller (1.0.1) + debug_inspector (>= 1.2.0) + builder (3.3.0) + climate_control (0.2.0) + coderay (1.1.3) + concurrent-ruby (1.3.4) + connection_pool (2.4.1) + crack (1.0.0) + bigdecimal + rexml + csv (3.3.0) + debase-ruby_core_source (3.3.1) + debug_inspector (1.2.0) + diff-lcs (1.5.1) + docile (1.4.1) + dogstatsd-ruby (5.6.1) + drb (2.2.1) + extlz4 (0.3.4) + ffi (1.16.3) + fileutils (1.7.2) + google-protobuf (3.25.4-aarch64-linux) + hashdiff (1.1.1) + i18n (1.14.6) + concurrent-ruby (~> 1.0) + json (2.7.2) + json-schema (2.8.1) + addressable (>= 2.4) + language_server-protocol (3.17.0.3) + libdatadog (12.0.0.1.0-aarch64-linux) + libddwaf (1.14.0.0.0-aarch64-linux) + ffi (~> 1.0) + lint_roller (1.1.0) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + logger (1.6.1) + memory_profiler (0.9.14) + method_source (1.1.0) + minitest (5.25.1) + msgpack (1.7.2) + os (1.1.4) + parallel (1.26.3) + parser (3.3.5.0) + ast (~> 2.4.1) + racc + pimpmychangelog (0.1.3) + prism (1.0.0) + pry (0.14.2) + coderay (~> 1.1) + method_source (~> 1.0) + pry-stack_explorer (0.6.1) + binding_of_caller (~> 1.0) + pry (~> 0.13) + public_suffix (6.0.1) + racc (1.8.1) + rainbow (3.1.1) + rake (13.2.1) + rake-compiler (1.2.7) + rake + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rbs (3.2.2) + redcarpet (3.6.0) + regexp_parser (2.9.2) + rexml (3.3.7) + rspec (3.13.0) + rspec-core (~> 3.13.0) + rspec-expectations (~> 3.13.0) + rspec-mocks (~> 3.13.0) + rspec-collection_matchers (1.2.1) + rspec-expectations (>= 2.99.0.beta1) + rspec-core (3.13.1) + rspec-support (~> 3.13.0) + rspec-expectations (3.13.3) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-mocks (3.13.1) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-support (3.13.1) + rspec-wait (0.0.10) + rspec (>= 3.0) + rspec_junit_formatter (0.6.0) + rspec-core (>= 2, < 4, != 2.12.0) + rubocop (1.50.2) + json (~> 2.3) + parallel (~> 1.10) + parser (>= 3.2.0.0) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.8, < 3.0) + rexml (>= 3.2.5, < 4.0) + rubocop-ast (>= 1.28.0, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 3.0) + rubocop-ast (1.32.3) + parser (>= 3.3.1.0) + rubocop-capybara (2.21.0) + rubocop (~> 1.41) + rubocop-packaging (0.5.2) + rubocop (>= 1.33, < 2.0) + rubocop-performance (1.16.0) + rubocop (>= 1.7.0, < 2.0) + rubocop-ast (>= 0.4.0) + rubocop-rspec (2.20.0) + rubocop (~> 1.33) + rubocop-capybara (~> 2.17) + ruby-lsp (0.17.17) + language_server-protocol (~> 3.17.0) + prism (~> 1.0) + rbs (>= 3, < 4) + sorbet-runtime (>= 0.5.10782) + ruby-progressbar (1.13.0) + securerandom (0.3.1) + simplecov-cobertura (2.1.0) + rexml + simplecov (~> 0.19) + simplecov-html (0.13.1) + simplecov_json_formatter (0.1.4) + sorbet-runtime (0.5.11558) + standard (1.28.5) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.50.2) + standard-custom (~> 1.0.0) + standard-performance (~> 1.0.1) + standard-custom (1.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.50) + standard-performance (1.0.1) + lint_roller (~> 1.0) + rubocop-performance (~> 1.16.0) + steep (1.6.0) + activesupport (>= 5.1) + concurrent-ruby (>= 1.1.10) + csv (>= 3.0.9) + fileutils (>= 1.1.0) + json (>= 2.1.0) + language_server-protocol (>= 3.15, < 4.0) + listen (~> 3.0) + logger (>= 1.3.0) + parser (>= 3.1) + rainbow (>= 2.2.2, < 4.0) + rbs (>= 3.1.0) + securerandom (>= 0.1) + strscan (>= 1.0.0) + terminal-table (>= 2, < 4) + strscan (3.1.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + thor (1.3.2) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (2.6.0) + warning (1.4.0) + webmock (3.23.1) + addressable (>= 2.8.0) + crack (>= 0.3.2) + hashdiff (>= 0.4.0, < 2.0.0) + webrick (1.8.1) + yard (0.9.37) + +PLATFORMS + aarch64-linux + +DEPENDENCIES + appraisal (~> 2.4.0) + benchmark-ips (~> 2.8) + benchmark-memory (< 0.2) + builder + climate_control (~> 0.2.0) + concurrent-ruby + datadog! + dogstatsd-ruby (>= 3.3.0, != 5.1.0, != 5.0.1, != 5.0.0) + extlz4 (~> 0.3, >= 0.3.3) + ffi (~> 1.16.3) + google-protobuf (~> 3.0, != 3.7.1, != 3.7.0) + json-schema (< 3) + memory_profiler (~> 0.9) + os (~> 1.1) + pimpmychangelog (>= 0.1.2) + pry + pry-stack_explorer + rake (>= 10.5) + rake-compiler (~> 1.1, >= 1.1.1) + rbs (~> 3.2.0) + redcarpet + rexml (>= 3.2.7) + rspec (~> 3.12) + rspec-collection_matchers (~> 1.1) + rspec-wait (~> 0) + rspec_junit_formatter (>= 0.5.1) + rubocop (~> 1.50.0) + rubocop-packaging (~> 0.5.2) + rubocop-performance (~> 1.9) + rubocop-rspec (~> 2.20, < 2.21) + ruby-lsp + simplecov! + simplecov-cobertura (~> 2.1.0) + standard + steep (~> 1.6.0) + warning (~> 1) + webmock (>= 3.10.0) + webrick (>= 1.7.0) + yard + +BUNDLED WITH + 2.3.27 diff --git a/yard.gemfile b/yard.gemfile new file mode 100644 index 00000000000..e69de29bb2d