gitlab-grape-openapi 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +52 -0
- data/lib/gitlab/grape_openapi/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: afbabc9163e59aafb950577da68e96bd817c5c4357e2eae88aabe4b75baaaf1f
|
|
4
|
+
data.tar.gz: 74a9b9a8abb13c4a122bf59169dd7aaa147162f68b781b47d729c52bd8440f50
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c9af1518142acff74821ed05d46605c9f6e33b8f08ccc33d438324196467dc573d6661b48d5b9b247d362b8b864ce0909755d8952d3e1b302b077bfa03aa6b7f
|
|
7
|
+
data.tar.gz: 03161ba25486070010a7ec67f2955a42f5d82e46c0eb78dbb4065f5df49870b69d9927a78afa40b513c04e9075806005eb558354cf59f4db10946928001a6cb1
|
data/README.md
CHANGED
|
@@ -266,6 +266,58 @@ merge:
|
|
|
266
266
|
The first rule is the one that publishes: a `push` to the default
|
|
267
267
|
branch that changes `lib/**/version.rb`.
|
|
268
268
|
|
|
269
|
+
#### Verifying changes against `gitlab-org/gitlab`
|
|
270
|
+
|
|
271
|
+
Because the monorepo consumes this gem from RubyGems, a change can pass
|
|
272
|
+
this gem's own specs locally yet still break `gitlab-org/gitlab` CI once
|
|
273
|
+
the published gem is pulled in. Verify both locally and in CI before
|
|
274
|
+
releasing.
|
|
275
|
+
|
|
276
|
+
**Locally**, point the monorepo's `Gemfile` at your working copy of this
|
|
277
|
+
gem with a `path:` override:
|
|
278
|
+
|
|
279
|
+
```ruby
|
|
280
|
+
gem 'gitlab-grape-openapi', path: '<absolute path to this repo>', feature_category: :api
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Run `bundle install` in the monorepo, then exercise the affected paths
|
|
284
|
+
(for example regenerate the spec with `bin/rake gitlab:openapi:v3:generate`
|
|
285
|
+
and run the relevant specs). When finished, revert with
|
|
286
|
+
`git restore Gemfile Gemfile.lock` so the override does not leak into a
|
|
287
|
+
commit.
|
|
288
|
+
|
|
289
|
+
**In CI**, a `path:` override only sees your local checkout, so open a
|
|
290
|
+
throwaway merge request in `gitlab-org/gitlab` that pins the `Gemfile` to
|
|
291
|
+
the exact commit you want to test and let its pipeline run. Replace the
|
|
292
|
+
dependency line:
|
|
293
|
+
|
|
294
|
+
```ruby
|
|
295
|
+
gem 'gitlab-grape-openapi', '~> <CURRENT_VERSION>', feature_category: :api
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
with a Git source:
|
|
299
|
+
|
|
300
|
+
```ruby
|
|
301
|
+
gem 'gitlab-grape-openapi',
|
|
302
|
+
git: 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-grape-openapi.git',
|
|
303
|
+
ref: '<commit SHA>',
|
|
304
|
+
feature_category: :api
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
Pinning with `ref:` (rather than `branch:`) freezes the exact commit so
|
|
308
|
+
CI does not drift if the branch moves. `Gemfile.next` is a symlink to
|
|
309
|
+
`Gemfile`, so this single edit covers both. Run `bundle install` to
|
|
310
|
+
regenerate `Gemfile.lock` with a GIT source block, commit it (do not
|
|
311
|
+
hand-edit it), and push. To faithfully reproduce the real migration's CI
|
|
312
|
+
conditions, also remove the in-tree gem under `gems/gitlab-grape-openapi/`
|
|
313
|
+
and its `.gitlab/ci/gitlab-gems.gitlab-ci.yml` and `.gitlab/CODEOWNERS`
|
|
314
|
+
entries, so Bundler cannot fall back to the vendored copy.
|
|
315
|
+
|
|
316
|
+
This throwaway branch is verification-only — do not merge it. Once the
|
|
317
|
+
gem is published, the real version bump uses a `'~> <NEW_VERSION>'`
|
|
318
|
+
constraint instead of the Git source (see the post-release steps in
|
|
319
|
+
`CLAUDE.md`).
|
|
320
|
+
|
|
269
321
|
## Contributing
|
|
270
322
|
|
|
271
323
|
This gem is maintained by GitLab's API Platform team for internal use.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: gitlab-grape-openapi
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- group::api
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-06-
|
|
11
|
+
date: 2026-06-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: grape
|
|
@@ -16,14 +16,14 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - "~>"
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 2.0
|
|
19
|
+
version: '2.0'
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: 2.0
|
|
26
|
+
version: '2.0'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: grape-entity
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|