Merge rswag:master

.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,3 +1,11 @@
+---
+name: 🐛 Bug
+about: File a bug/issue with Rswag that is not working
+title: '[BUG] <title>'
+labels: Bug, Needs Triage
+assignees: ''
+---
+
 ## Describe the bug
 A clear and concise description of what the bug is.
 
@@ -13,5 +21,14 @@ If applicable, add screenshots to help explain your problem.
 ## Additional context
 Add any other context about the problem here.
 
-## Rswag Version
-The version of rswag are you using.
+## Dependency versions
+The version of are you using for:
+* Rswag:
+* RSpec:
+* Rails:
+* Ruby:
+
+## Relates to which version of OAS (OpenAPI Specification)
+- [ ] OAS2
+- [ ] OAS3
+- [ ] OAS3.1

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,11 +1,29 @@
+---
+name: 🙏 Request
+about: Request something from the community
+title: '[REQUEST] <title>'
+labels: Request, Needs Triage
+assignees: ''
+---
+
 ## Is your feature request related to a problem? Please describe.
 A clear and concise description of what the problem is.
 
 ## Describe the solution you'd like
 A clear and concise description of what you want to happen.
 
+## What support could we give you, so you could implement this yourself?
+Please tell us how could we help you implement this feature, so you could
+become a contributor. **Our time is limited, so it's unlikely that we will
+be able to implement this ourselves, but we will try to help you**
+
 ## Describe alternatives you've considered
 A clear and concise description of any alternative solutions or features you've considered.
 
 ## Additional context
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.
+
+## Relates to which version of OAS (OpenAPI Specification)
+- [ ] OAS2
+- [ ] OAS3
+- [ ] OAS3.1

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,26 @@
+## Problem
+A clear and concise description of what the problem is.
+
+## Solution
+A clear and concise description of what the solution is.
+
+### This concerns this parts of the OpenAPI Specification:
+* [EXAMPLE_LINK TO RELEVANT OPEN API SPECS PAGE](https://spec.openapis.org/oas/v3.1.0#data-types)
+* [ANOTHER LINK TO RELEVANT OPEN API SPECS PAGE](https://spec.openapis.org/oas/v3.1.0#schema)
+
+### The changes I made are compatible with:
+- [ ] OAS2
+- [ ] OAS3
+- [ ] OAS3.1
+
+### Related Issues
+Links to any related issues.
+
+### Checklist
+- [ ] Added tests
+- [ ] Changelog updated
+- [ ] Added documentation to README.md
+- [ ] Added example of using the enhancement into [test-app](https://github.com/rswag/rswag/tree/master/test-app)
+
+### Steps to Test or Reproduce
+Outline the steps to test or reproduce the PR here.

.github/stale.yml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+# ToDo: reduce to 90 days once issue backlog is under control
+daysUntilStale: 365
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 14
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. If the issue is 
+  still relevant to you, please leave a comment stating so to keep the issue
+  from being closed. Thank you for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/deploy-rswag.yml

@@ -0,0 +1,78 @@
+name: Publish Rswag Gems
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "gem version to publish"
+        type: string
+        required: true
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby 3.3
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3.4
+
+      - name: Publish rswag-api
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          cd rswag-api
+          gem build rswag-api.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
+          RUBYGEMS_VERSION: "${{github.event.inputs.version}}"
+
+      - name: Publish rswag-specs
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          cd rswag-specs
+          gem build rswag-specs.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
+          RUBYGEMS_VERSION: "${{github.event.inputs.version}}"
+
+      - name: Publish rswag-ui
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          cd rswag-ui
+          npm install
+          gem build rswag-ui.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
+          RUBYGEMS_VERSION: "${{github.event.inputs.version}}"
+
+      - name: Publish rswag
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          cd rswag
+          gem build rswag.gemspec
+          echo $RUBYGEMS_VERSION
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
+          RUBYGEMS_VERSION: "${{github.event.inputs.version}}"

.github/workflows/ruby.yml

@@ -10,18 +10,71 @@ jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, truffleruby-head]
-        rails: [5.2.4.4, 6.0.3.4]
+        # Ruby 2.6 became EOL on 2022-03-31; kept for information only
+        # Ruby 2.7 became EOL on 2023-03-31; kept for information only
+        # Ruby 3.0 became EOL on 2024-04-23; kept for information only
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
+
+        # Rails 5.2 became EOL on 2022-06-01; kept for information only
+        # Rails 6.0 became EOL on 2023-06-01; kept for information only
+        # Rails 6.1 became EOL on 2024-10-01; kept for information only
+        rails: ['5.2.8.1', '6.0.6.1', '6.1.7.8', '7.0.8.4', '7.1.3.4', '7.2.0', '8.0.0']
+
+        exclude:
+        # Excludes Rails 5.2 on Ruby 3.0+
+        # Excludes Rails 6.0 on Ruby 3.0+
+        # Excludes Rails 7.0 on Ruby 2.6
+        # Excludes Rails 7.1 on Ruby 2.6
+        # Excludes Rails 7.2 on Ruby 2.6, 2.7, 3.0
+        # Excludes Rails 8.0 on Ruby 2.6, 2.7, 3.0, 3.1
+        - rails: '5.2.8.1'
+          ruby: '3.0'
+        - rails: '5.2.8.1'
+          ruby: '3.1'
+        - rails: '5.2.8.1'
+          ruby: '3.2'
+        - rails: '5.2.8.1'
+          ruby: '3.3'
+        - rails: '6.0.6.1'
+          ruby: '3.0'
+        - rails: '6.0.6.1'
+          ruby: '3.1'
+        - rails: '6.0.6.1'
+          ruby: '3.2'
+        - rails: '6.0.6.1'
+          ruby: '3.3'
+        - rails: '7.0.8.4'
+          ruby: '2.6'
+        - rails: '7.1.3.4'
+          ruby: '2.6'
+        - rails: '7.2.0'
+          ruby: '2.6'
+        - rails: '7.2.0'
+          ruby: '2.7'
+        - rails: '7.2.0'
+          ruby: '3.0'
+        - rails: '8.0.0'
+          ruby: '2.6'
+        - rails: '8.0.0'
+          ruby: '2.7'
+        - rails: '8.0.0'
+          ruby: '3.0'
+        - rails: '8.0.0'
+          ruby: '3.1'
+    name: Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }}
     env:
       RAILS_VERSION: ${{ matrix.rails }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
-      with: { ruby-version: 2.6 }
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
 
-    - uses: actions/cache@v2
+    - uses: actions/cache@v4
       id: cache
       with:
         path: |
@@ -31,6 +84,11 @@ jobs:
 
     - name: Install dependencies
       run: |
+        if [ $(cut -d '.' -f 1 <<< "${{ matrix.ruby }}") -lt 3 ]; then
+          gem update --system 3.4.22
+        else
+          gem update --system
+        fi
         bundle install
         cd rswag-ui && npm install
 

.github/workflows/spellcheck.yml

@@ -0,0 +1,18 @@
+name: Spellchecking
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  spellchecking:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: streetsidesoftware/cspell-action@v5
+        with:
+          config: "./cspell.json"

.gitignore

@@ -8,3 +8,4 @@
 Gemfile.lock
 /.idea/
 **/.byebug_history
+**/coverage

.ruby-version

@@ -1 +1 @@
-2.7.2
+2.7.6