Skip to content

Commit 5dc3680

Browse files
danielhspangdanielhspang
authored
Merge pull request #11 from instacart/danielpang/PL-54908/merge-rswag-master
[PL-54908] Merge rswag master in IC rswag
2 parents 5fc6c32 + 0111952 commit 5dc3680

File tree

142 files changed

+5116
-2763
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+5116
-2763
lines changed

‎.dockerignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Gemfile.lock

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
name: 🐛 Bug
3+
about: File a bug/issue with Rswag that is not working
4+
title: '[BUG] <title>'
5+
labels: Bug, Needs Triage
6+
assignees: ''
7+
---
8+
19
## Describe the bug
210
A clear and concise description of what the bug is.
311

@@ -13,5 +21,13 @@ If applicable, add screenshots to help explain your problem.
1321
## Additional context
1422
Add any other context about the problem here.
1523

16-
## Rswag Version
17-
The version of rswag are you using.
24+
## Dependency versions
25+
The version of are you using for:
26+
* Rswag:
27+
* RSpec:
28+
* Rails:
29+
* Ruby:
30+
31+
## Relates to which version of OAS (OpenAPI Specification)
32+
- [ ] OAS3
33+
- [ ] OAS3.1

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1+
---
2+
name: 🙏 Request
3+
about: Request something from the community
4+
title: '[REQUEST] <title>'
5+
labels: Request, Needs Triage
6+
assignees: ''
7+
---
8+
19
## Is your feature request related to a problem? Please describe.
210
A clear and concise description of what the problem is.
311

412
## Describe the solution you'd like
513
A clear and concise description of what you want to happen.
614

15+
## What support could we give you, so you could implement this yourself?
16+
Please tell us how could we help you implement this feature, so you could
17+
become a contributor. **Our time is limited, so it's unlikely that we will
18+
be able to implement this ourselves, but we will try to help you**
19+
720
## Describe alternatives you've considered
821
A clear and concise description of any alternative solutions or features you've considered.
922

1023
## Additional context
11-
Add any other context or screenshots about the feature request here.
24+
Add any other context or screenshots about the feature request here.
25+
26+
## Relates to which version of OAS (OpenAPI Specification)
27+
- [ ] OAS3
28+
- [ ] OAS3.1

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.github/dependabot.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

‎.github/pull_request_template.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Problem
2+
A clear and concise description of what the problem is.
3+
4+
## Solution
5+
A clear and concise description of what the solution is.
6+
7+
### This concerns this parts of the OpenAPI Specification:
8+
* [EXAMPLE_LINK TO RELEVANT OPEN API SPECS PAGE](https://spec.openapis.org/oas/v3.1.0#data-types)
9+
* [ANOTHER LINK TO RELEVANT OPEN API SPECS PAGE](https://spec.openapis.org/oas/v3.1.0#schema)
10+
11+
### The changes I made are compatible with:
12+
- [ ] OAS3
13+
- [ ] OAS3.1
14+
15+
### Related Issues
16+
Links to any related issues.
17+
18+
### Checklist
19+
- [ ] Added tests
20+
- [ ] Changelog updated
21+
- [ ] Added documentation to README.md
22+
- [ ] Added example of using the enhancement into [test-app](https://github.com/rswag/rswag/tree/master/test-app)
23+
24+
### Steps to Test or Reproduce
25+
Outline the steps to test or reproduce the PR here.

‎.github/stale.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
# ToDo: reduce to 90 days once issue backlog is under control
3+
daysUntilStale: 365
4+
# Number of days of inactivity before a stale issue is closed
5+
daysUntilClose: 14
6+
# Issues with these labels will never be considered stale
7+
exemptLabels:
8+
- pinned
9+
- security
10+
# Label to use when marking an issue as stale
11+
staleLabel: wontfix
12+
# Comment to post when marking an issue as stale. Set to `false` to disable
13+
markComment: >
14+
This issue has been automatically marked as stale because it has not had
15+
recent activity. It will be closed if no further activity occurs. If the issue is
16+
still relevant to you, please leave a comment stating so to keep the issue
17+
from being closed. Thank you for your contributions.
18+
# Comment to post when closing a stale issue. Set to `false` to disable
19+
closeComment: false

‎.github/workflows/deploy-rswag.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Publish Rswag Gems
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
version:
7+
description: "gem version to publish"
8+
type: string
9+
required: true
10+
11+
jobs:
12+
build:
13+
name: Build + Publish
14+
runs-on: ubuntu-latest
15+
permissions:
16+
contents: read
17+
packages: write
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
- name: Set up Ruby 3.3
22+
uses: ruby/setup-ruby@v1
23+
with:
24+
ruby-version: 3.3.4
25+
26+
- name: Publish rswag-api
27+
run: |
28+
mkdir -p $HOME/.gem
29+
touch $HOME/.gem/credentials
30+
chmod 0600 $HOME/.gem/credentials
31+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
32+
cd rswag-api
33+
gem build rswag-api.gemspec
34+
gem push *.gem
35+
env:
36+
GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
37+
RUBYGEMS_VERSION: "${{github.event.inputs.version}}"
38+
39+
- name: Publish rswag-specs
40+
run: |
41+
mkdir -p $HOME/.gem
42+
touch $HOME/.gem/credentials
43+
chmod 0600 $HOME/.gem/credentials
44+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
45+
cd rswag-specs
46+
gem build rswag-specs.gemspec
47+
gem push *.gem
48+
env:
49+
GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
50+
RUBYGEMS_VERSION: "${{github.event.inputs.version}}"
51+
52+
- name: Publish rswag-ui
53+
run: |
54+
mkdir -p $HOME/.gem
55+
touch $HOME/.gem/credentials
56+
chmod 0600 $HOME/.gem/credentials
57+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
58+
cd rswag-ui
59+
npm install
60+
gem build rswag-ui.gemspec
61+
gem push *.gem
62+
env:
63+
GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
64+
RUBYGEMS_VERSION: "${{github.event.inputs.version}}"
65+
66+
- name: Publish rswag
67+
run: |
68+
mkdir -p $HOME/.gem
69+
touch $HOME/.gem/credentials
70+
chmod 0600 $HOME/.gem/credentials
71+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
72+
cd rswag
73+
gem build rswag.gemspec
74+
echo $RUBYGEMS_VERSION
75+
gem push *.gem
76+
env:
77+
GEM_HOST_API_KEY: "${{secrets.BOOKOFGREG_RUBYGEMS_API_KEY}}"
78+
RUBYGEMS_VERSION: "${{github.event.inputs.version}}"

‎.github/workflows/rubocop.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Rubocop
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
rubocop:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: ruby/setup-ruby@v1
13+
with:
14+
ruby-version: 3.2
15+
bundler-cache: true
16+
- name: Install dependencies
17+
run: bundle install
18+
- name: Run rubocop checks
19+
run: bundle exec rubocop

0 commit comments

Comments
 (0)