grape-swagger-rails 1.0.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97001ea5dddef8b88dec458db3cdaa67b831bce1e79786c9039a1f22116997c
-  data.tar.gz: 16f873ac0fe788d2adff17b2dd1ddc0b9af0f2be771bea694ecaf2b55d3046cf
+  metadata.gz: ce061b25fb97c60e7fb24ac904116dd39723899ae633b81b6213868c322cc304
+  data.tar.gz: 58775278995267631da4e3d93b0d058d540ac78b8fa1ed8f02c6a672ea233a57
 SHA512:
-  metadata.gz: d7ea05d2aff082469f8e454a8cd624be5c3851359be4d189ec9248a38c806d5ae5dba4f3c6a78d34efbe1842d59f7c80c0529aee6392a942aa47f47560679e53
-  data.tar.gz: dd4490bc71b0366ca9ccfd2c9b2b6a0798a1f7e659cbf0b91e535c68e06da3318b2b45399dac7ccf0cffe664414641b30adc6d6fe7b29c8a2c0a6b84cf088e02
+  metadata.gz: 9a7112bdaa28e3c148bf127ec3f0583463961c080ef06f4a19dc7458fba713282d9f2909f19eb93b6d4d749df7d460315f8274be1907ecef138bde4fb3561d4a
+  data.tar.gz: 8ef3f5fa56a1d166ec806e3ca51692ba407bc82af058979fdecc7b7c9e2911db6684e536eae115a5ab3e1ba48835adca2441e60a09b47a06f4f667de321bb9fe

data/.github/workflows/swagger-ui-update.yml

@@ -47,6 +47,7 @@ jobs:
         run: bundle exec rake swagger_ui:dist:update
 
       - name: Create pull request
+        id: pull-request
         if: steps.swagger-ui.outputs.update-needed == 'true'
         uses: peter-evans/create-pull-request@v7
         with:
@@ -59,3 +60,28 @@ jobs:
             Updates bundled Swagger UI assets from swagger-api/swagger-ui `${{ steps.swagger-ui.outputs.latest-tag }}`.
 
             Generated by the scheduled Swagger UI update workflow.
+
+      # PRs created with GITHUB_TOKEN do not trigger the Danger PR workflow.
+      - name: Add the pull request to the changelog
+        if: steps.pull-request.outputs.pull-request-number != ''
+        env:
+          GH_TOKEN: ${{ github.token }}
+          PR_NUMBER: ${{ steps.pull-request.outputs.pull-request-number }}
+          PR_BRANCH: update-swagger-ui-${{ steps.swagger-ui.outputs.latest-version }}
+        run: |
+          git fetch origin "$PR_BRANCH"
+          git checkout -B "$PR_BRANCH" FETCH_HEAD
+          PR_URL="$(gh pr view "$PR_NUMBER" --json url --jq .url)"
+          PR_TITLE="$(gh pr view "$PR_NUMBER" --json title --jq .title)"
+          PR_AUTHOR="$(gh api "repos/${GITHUB_REPOSITORY}/pulls/${PR_NUMBER}" --jq .user.login)"
+          PR_AUTHOR_URL="$(gh api "repos/${GITHUB_REPOSITORY}/pulls/${PR_NUMBER}" --jq .user.html_url)"
+          export PR_URL PR_TITLE PR_AUTHOR PR_AUTHOR_URL
+          ruby script/update_changelog
+          if git diff --quiet -- CHANGELOG.md; then
+            exit 0
+          fi
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git add CHANGELOG.md
+          git commit -m "Update changelog for #${PR_NUMBER}"
+          git push origin "$PR_BRANCH"

data/.github/workflows/test.yml

@@ -10,39 +10,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - ruby: '3.2'
-            rails: '7.2.2.2'
-            grape: '~> 1.8.0'
-            grape-swagger: '1.6.1'
-          - ruby: '3.2'
-            rails: '7.2.2.2'
-            grape: '~> 3.1.0'
-            grape-swagger: '2.1.4'
-          - ruby: '3.3'
-            rails: '7.2.2.2'
-            grape: '~> 3.1.0'
-            grape-swagger: '2.1.4'
-          - ruby: '3.4'
-            rails: '7.2.2.2'
-            grape: '~> 3.1.0'
-            grape-swagger: '2.1.4'
-          - ruby: '3.2'
-            rails: '~> 8.1.3'
-            grape: '~> 3.1.0'
-            grape-swagger: '2.1.4'
-          - ruby: '3.3'
-            rails: '~> 8.1.3'
-            grape: '~> 3.1.0'
-            grape-swagger: '2.1.4'
-          - ruby: '3.4'
-            rails: '~> 8.1.3'
-            grape: '~> 3.1.0'
-            grape-swagger: '2.1.4'
+        ruby: ['3.2', '3.3', '3.4']
+        rails: ['~> 8.1.4']
+        json: ['~> 2.0', '~> 3.0']
     env:
-      GRAPE_VERSION: ${{ matrix.grape }}
-      GRAPE_SWAGGER_VERSION: ${{ matrix.grape-swagger }}
+      GRAPE_VERSION: '~> 3.1.0'
+      GRAPE_SWAGGER_VERSION: '2.1.4'
       RAILS_VERSION: ${{ matrix.rails }}
+      JSON_VERSION: ${{ matrix.json }}
     steps:
       - uses: actions/checkout@v6
       - name: Set up Ruby

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * Your contribution here.
 
+### 2.0.0 (2026/10/02)
+
+* [#179](https://github.com/ruby-grape/grape-swagger-rails/pull/179): Require Rails 8.1.4+ and allow JSON 3 - [@moskvin](https://github.com/moskvin).
+
+### 1.0.10 (2026/09/22)
+
+* [#177](https://github.com/ruby-grape/grape-swagger-rails/pull/177): Bump Swagger UI to 5.33.0 - [@moskvin](https://github.com/moskvin).
+
 ### 1.0.9 (2026/09/08)
 
 * [#176](https://github.com/ruby-grape/grape-swagger-rails/pull/176): Bump Swagger UI to 5.32.15 - [@moskvin](https://github.com/moskvin).

data/CLAUDE.md

@@ -73,8 +73,7 @@ Config in `.rubocop.yml` targets Ruby 3.4. Plugins: rubocop-capybara, rubocop-rs
 
 ## Compatibility Matrix
 
-- Rails 7.2 / 8.1 × Ruby 3.2–3.4 × grape-swagger 2.1.4 (grape ~> 3.1)
-- Rails 7.2 × Ruby 3.2 × grape-swagger 1.6.1 (grape ~> 1.8) — legacy combination
+- Rails 8.1.4–8.1.x × Ruby 3.2–3.4 × JSON 2/3 × grape-swagger 2.1.4 (grape ~> 3.1)
 - Ruby 3.1 is excluded from Rails 8 (requires 3.2+)
 - grape ~> 1.8 is not tested on Ruby 3.4: Ruby 3.4 tightened `Forwardable` to raise on private-method delegation, which breaks Mustermann's `named_captures` forwarding used by grape-swagger 1.6.1 to introspect routes
 - Both Sprockets and Propshaft asset pipelines are tested in CI

data/CONTRIBUTING.md

@@ -123,6 +123,16 @@ Go back to your pull request after a few minutes and see whether it passed muste
 
 It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
 
+## Preparing a Release
+
+Run `bin/bump 1.0.11` with the desired new version. This updates the gem version
+and moves all entries under `Next Release` into a new section dated today,
+leaving `Your contribution here.` under `Next Release`. It refuses empty releases
+and versions that are not newer than the current version.
+
+Review the diff, commit it, and follow the usual gem release process. The script
+does not commit, tag, push, or publish the gem.
+
 ## Thank You
 
 Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -18,13 +18,15 @@ else
   gem 'grape-swagger', grape_swagger_version
 end
 
-case rails_version = ENV.fetch('RAILS_VERSION', '>= 7.2.3.1')
+case rails_version = ENV.fetch('RAILS_VERSION', '>= 8.1.4')
 when 'edge'
   gem 'railties', github: 'rails/rails', branch: 'main'
 else
   gem 'railties', rails_version
 end
 
+gem 'json', ENV.fetch('JSON_VERSION') if ENV.key?('JSON_VERSION')
+
 group :development, :test do
   gem 'capybara'
   gem 'danger', require: false

data/README.md

@@ -44,13 +44,12 @@ Or install it yourself as:
 
 This gem is continuously tested against the following stack:
 
-| Ruby | Rails   | Grape   | grape-swagger | Swagger UI |
-|-----:|--------:|--------:|--------------:|-----------:|
-| 3.4  | 7.2.2.2 | 1.8.x   | 1.6.1         | 5.32.15     |
-| 3.2+ | 7.2.2.2 | 3.1.x   | 2.1.4         | 5.32.15     |
-| 3.2+ | 8.1.x   | 3.1.x   | 2.1.4         | 5.32.15     |
+| Ruby | Rails  | JSON    | Grape | grape-swagger | Swagger UI |
+|-----:|-------:|--------:|------:|--------------:|-----------:|
+| 3.2+ | 8.1.4–8.1.x | 2.x/3.x | 3.1.x | 2.1.4         | 5.33.0     |
 
 The dummy app and CI also exercise both supported Rails asset pipelines: Sprockets and Propshaft.
+Rails 8.1.4 is required for JSON 3 compatibility; older Rails versions remain supported by the 1.x gem releases.
 
 If you use a nearby version and hit an issue, please open one with your `Gemfile.lock` and a minimal reproduction.
 

data/UPGRADING.md

@@ -1,6 +1,23 @@
 Upgrading Grape Swagger Rails
 =============================
 
+### Upgrading to 2.0.0
+
+Version `2.0.0` drops support for Rails versions older than 8.1.4 and allows JSON 3. See [#179](https://github.com/ruby-grape/grape-swagger-rails/pull/179).
+
+#### Upgrade checklist
+
+1. Upgrade your application to Rails `>= 8.1.4, < 8.2`. The gem now depends on `railties >= 8.1.4, < 8.2` (previously `>= 7.2.2.2, < 8.2`); Rails 8.1.4 is the first release compatible with JSON 3.
+2. The Ruby requirement is unchanged (`>= 3.2`).
+3. The `json < 3.0` upper bound was removed, so both `json` 2.x and 3.x are supported. No configuration changes are needed.
+4. If you cannot upgrade Rails yet, stay on the 1.x line:
+
+   ```ruby
+   gem 'grape-swagger-rails', '~> 1.0'
+   ```
+
+No `GrapeSwaggerRails.options` or template changes are required.
+
 ### Upgrading to 1.0.0
 
 Version `1.0.0` includes a major Swagger UI integration refresh and several configuration additions.