Skip to content

Add CI linting check #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Foorack merged 5 commits into from
Jul 16, 2021
Merged

Add CI linting check #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8e5de9a
Implement Linting check during CI
Foorack Jul 14, 2021
05b7235
Set severity limit to hint+
Foorack Jul 14, 2021
1ba633b
Cache node_modules
Foorack Jul 14, 2021
80e02d3
Add linting config and change severity threshold to warn
Foorack Jul 14, 2021
d8193e1
Update package.json
Foorack Jul 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,26 @@ on: [push, pull_request]
name: Continuous Integration

jobs:
lint:
runs-on: ubuntu-latest
name: Lint OpenAPI specification
steps:
- uses: actions/setup-node@v1
with:
node-version: 12
- uses: actions/checkout@v2
- name: 'Cache node_modules'
uses: actions/cache@v2
with:
path: node_modules
key: ${{ runner.os }}-node-v12-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-v12
- name: Install Dependencies
run: npm install
- name: Run Spectral linting
run: npm run lint

bundle:
runs-on: ubuntu-latest
name: Bundle OpenAPI specification
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/node_modules
10 changes: 10 additions & 0 deletions .spectral.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
formats:
- oas3
extends:
- 'spectral:oas'
rules:
contact-properties: warn
info-license: warn
license-url: warn
oas3-parameter-description: info
tag-description: hint
24 changes: 12 additions & 12 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,7 +880,7 @@ paths:
examples:
Example Response:
value:
url: 'https://s3.amazonaws.com/files.vrchat.cloud/Avatar-MyAvatar-Un.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Expires=1626028518&Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&partNumber=1&uploadId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxxxx'
url: 'https://s3.amazonaws.com/files.vrchat.cloud/Avatar-MyAvatar-Un.file_00000000-0000-0000-0000-000000000000.1.unitypackage?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Expires=1626028518&Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&partNumber=1&uploadId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxxxx'
'400':
description: Error response when trying to start an upload against a FileVersion that is already marked as `complete`.
content:
Expand Down Expand Up @@ -1224,10 +1224,10 @@ components:
examples:
Example Avatar File:
value:
id: file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
id: file_00000000-0000-0000-0000-000000000000
name: Avatar - Test Avatar - Unity package - 2017․4․28f1_3_standalonewindows_Release
ownerId: usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469
mimeType: application/gzip
mimeType: 'application⁄gzip'
extension: .unitypackage
tags: []
versions:
Expand All @@ -1238,24 +1238,24 @@ components:
status: complete
created_at: '2019-08-15T11:04:49.702Z'
file:
fileName: Avatar-Test-Avatar-Unity.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage
url: 'https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage'
fileName: Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage
url: 'https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage'
md5: xxxxxxxxxxxxxxxxxxx==
sizeInBytes: 303055180
status: complete
category: multipart
uploadId: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
delta:
fileName: Avatar-Test-Avatar-Unity.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage.delta
url: 'https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage.delta'
fileName: Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.delta
url: 'https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.delta'
md5: ''
sizeInBytes: 0
status: none
category: queued
uploadId: ''
signature:
fileName: Avatar-Test-Avatar-Unity.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage.signature
url: 'https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage.signature'
fileName: Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.signature
url: 'https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.signature'
md5: xxxxxxxxxxxxxxxx==
sizeInBytes: 532748
status: complete
Expand Down Expand Up @@ -1339,7 +1339,7 @@ components:
fileName:
type: string
minLength: 1
example: Avatar-MyAvatar-Un.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage
example: Avatar-MyAvatar-Un.file_00000000-0000-0000-0000-000000000000.1.unitypackage
readOnly: true
nextPartNumber:
type: number
Expand Down Expand Up @@ -1378,7 +1378,7 @@ components:
Example Access Key:
value:
uploadId: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxxxx
fileName: Avatar-MyAvatar-Un.file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.1.unitypackage
fileName: Avatar-MyAvatar-Un.file_00000000-0000-0000-0000-000000000000.1.unitypackage
nextPartNumber: 0
maxParts: 1000
parts: []
Expand Down Expand Up @@ -1416,7 +1416,7 @@ components:
required: true
schema:
type: string
example: file_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
example: file_00000000-0000-0000-0000-000000000000
pattern: 'file_[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}'
versionId:
name: versionId
Expand Down
Loading