Merge branch 'master' into module_lookup_bugfix

Author: st0012

.document

@@ -1,7 +1,4 @@
-History.txt
-LICENSE.txt
-README.txt
-RI.txt
-RI.md
+*.md
+*.rdoc
 lib
 doc

.generated_files_rubocop.yml

@@ -0,0 +1,12 @@
+# This rubocop configuration is ONLY for the generated files (listed in Rakefile). It is not meant to be used for RDoc's
+# source code.
+# The purpose of this file is to ensure the generated files don't have trailing whitespace or empty lines, which could
+# be a problem for ruby/ruby's CI
+AllCops:
+  TargetRubyVersion: 3.3
+  DisabledByDefault: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+Layout/TrailingEmptyLines:
+  Enabled: true

.github/release.yml

@@ -0,0 +1,16 @@
+# release.yml
+
+changelog:
+  categories:
+    - title: ✨ Enhancements
+      labels:
+        - enhancement
+    - title: 🐛 Bug Fixes
+      labels:
+        - bug
+    - title: 📚 Documentation
+      labels:
+        - documentation
+    - title: 🛠 Other Changes
+      labels:
+        - "*"

.github/workflows/gh-pages.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Setup Ruby
-        uses: ruby/setup-ruby@1d0e911f615a112e322369596f10ee0b95b010ae # v1.183.0
+        uses: ruby/setup-ruby@1287d2b408066abada82d5ad1c63652e758428d9 # v1.214.0
         with:
           ruby-version: '3.2'
           bundler-cache: true

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: Lint
+
+on: [push, pull_request]
+
+permissions:  # added using https://github.com/step-security/secure-workflows
+  contents: read
+
+jobs:
+  lint:
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4 # v3.3.0
+    # libyaml-dev is needed for psych, see https://github.com/ruby/setup-ruby/issues/409
+    - if: ${{ matrix.os == 'ubuntu-latest' }}
+      run: sudo apt install libyaml-dev
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@master
+      with:
+        ruby-version: 3.3
+        bundler-cache: true
+    - name: Run rubocop
+      run: bundle exec rubocop
+    - name: Sanity check for the format_generated_files task
+      run: bundle exec rake generate format_generated_files
+

.github/workflows/push_gem.yml

@@ -0,0 +1,46 @@
+name: Publish gem to rubygems.org
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'ruby/rdoc'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/rdoc
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@1287d2b408066abada82d5ad1c63652e758428d9 # v1.214.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
+
+      - name: Create GitHub release
+        run: |
+          tag_name="$(git describe --tags --abbrev=0)"
+          gh release create "${tag_name}" --verify-tag --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.MATZBOT_GITHUB_WORKFLOW_TOKEN }}

.github/workflows/ruby-core.yml

@@ -15,14 +15,14 @@ permissions: # added using https://github.com/step-security/secure-workflows
 
 jobs:
   ruby_core:
-    name: RDoc under a ruby-core setup
+    name: Generate ruby/ruby documentation with the current RDoc commit
     runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
     timeout-minutes: 30
     steps:
       - name: Set up latest ruby head
-        uses: ruby/setup-ruby@1d0e911f615a112e322369596f10ee0b95b010ae # v1.183.0
+        uses: ruby/setup-ruby@1287d2b408066abada82d5ad1c63652e758428d9 # v1.214.0
         with:
           ruby-version: head
           bundler: none
@@ -45,15 +45,26 @@ jobs:
         run: |
           autoconf
           ./configure -C --disable-install-doc
-          make -j2
         working-directory: ruby/ruby
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v3.1.0
         with:
           path: ruby/rdoc
-      - name: Sync tools
+      - name: Build RDoc locally
         run: |
-          ruby tool/sync_default_gems.rb rdoc
+          bundle install
+          bundle exec rake build:local_ruby
+        working-directory: ruby/rdoc
+      - name: Generate Documentation with RDoc
+        run: make html
         working-directory: ruby/ruby
-      - name: Test RDoc
-        run: make -j2 -s test-all TESTS="rdoc --no-retry"
+      # We need to clear the generated documentation to generate them again
+      # with the Prism parser.
+      - name: Clear Generated Documentation
+        run: rm -r .ext/html
         working-directory: ruby/ruby
+      - name: Generate Documentation with RDoc (Prism parser)
+        run: make html
+        working-directory: ruby/ruby
+        env:
+          RDOC_USE_PRISM_PARSER: true
+

.github/workflows/test.yml

@@ -8,6 +8,11 @@ permissions:  # added using https://github.com/step-security/secure-workflows
 jobs:
   ruby-versions:
     uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      # 2.7 breaks `test_parse_statements_nodoc_identifier_alias_method`
+      min_version: 3.0
+      versions: '["mswin"]'
+      engine: cruby-truffleruby
 
   test:
     needs: ruby-versions
@@ -21,10 +26,11 @@ jobs:
             ruby: truffleruby
           - os: windows-latest
             ruby: truffleruby-head
-          - os: windows-latest
-            ruby: jruby
-          - os: windows-latest
-            ruby: jruby-head
+          - os: macos-latest
+            ruby: mswin
+          - os: ubuntu-latest
+            ruby: mswin
+
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4 # v3.3.0
@@ -36,14 +42,16 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # 'bundle install' and cache
-    # Avoid issues on these platforms
-    - if: ${{ matrix.ruby == '2.6' }}
-      run: gem update --system
     - name: Run test
       run: bundle exec rake
       env:
         RUBYOPT: --enable-frozen_string_literal
+    - name: Run test with Prism parser
+      run: bundle exec rake
+      env:
+        RUBYOPT: --enable-frozen_string_literal
+        RDOC_USE_PRISM_PARSER: true
     - if: ${{ matrix.ruby == 'head' && startsWith(matrix.os, 'ubuntu') }}
       run: bundle exec rake rdoc
     - if: ${{ matrix.ruby == 'head' && startsWith(matrix.os, 'ubuntu') }}
-      run: bundle exec rake rubocop
+      run: bundle exec rake install

.rdoc_options

@@ -0,0 +1,6 @@
+op_dir: _site # for GitHub Pages and should match the config of RDoc task in Rakefile
+title: rdoc Documentation
+main_page: README.rdoc
+warn_missing_rdoc_ref: true
+autolink_excluded_words:
+- RDoc

.rubocop.yml

@@ -1,10 +1,22 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   DisabledByDefault: true
-  Exclude:
-    - rdoc.gemspec
+  SuggestExtensions: false
 
 Layout/TrailingWhitespace:
   Enabled: true
+
 Layout/TrailingEmptyLines:
   Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true