-
Notifications
You must be signed in to change notification settings - Fork 287
Install yamllint
directly to use latest version
#3935
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.
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7d5c74c
Refactor linter stage to install yamllint directly and invoke from
shiftkey c9590a0
add .gitignore to hide node_modules from working directory
shiftkey 22da1c8
add strategy matrix and perform 3.1 linting for yaml releases
shiftkey 7cb9e49
add reminder
shiftkey File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -5,27 +5,39 @@ on: | |||
- push | ||||
|
||||
jobs: | ||||
build: | ||||
name: Lint OpenAPI Descriptions | ||||
lint: | ||||
name: Lint OpenAPI ${{matrix.version}} releases | ||||
runs-on: ubuntu-latest | ||||
strategy: | ||||
matrix: | ||||
include: | ||||
- version: '3.0' | ||||
files: 'descriptions/**/*.yaml' | ||||
- version: '3.1' | ||||
files: 'descriptions-next/**/*.yaml' | ||||
steps: | ||||
- name: Checkout Code | ||||
uses: actions/checkout@v4 | ||||
- name: Yaml Lint | ||||
uses: karancode/[email protected] | ||||
- uses: actions/setup-python@v5 | ||||
name: Install Python | ||||
with: | ||||
yamllint_file_or_dir: 'descriptions/**/*.yaml' | ||||
yamllint_strict: false | ||||
yamllint_config_filepath: '.yamllint-config.yml' | ||||
yamllint_comment: true | ||||
- uses: actions/setup-node@v3 | ||||
python-version: '3.12' | ||||
- run: pip install yamllint | ||||
name: Install yamllint | ||||
- run: yamllint -f parsable -c .yamllint-config.yml ${{matrix.files}} | ||||
name: Run yamllint on ${{matrix.version}} descriptions | ||||
- name: Install NodeJS | ||||
uses: actions/setup-node@v4 | ||||
with: | ||||
node-version: '16' | ||||
- run: npm install | ||||
- name: Install Node modules | ||||
run: npm ci | ||||
# TODO: update script to pass in {{files}} so that this can support 3.1 | ||||
- name: JSON Lint | ||||
run: npm run lint | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤔 this command is also hard-coded to run with rest-api-description/package.json Line 10 in 272a391
|
||||
- name: OpenAPI Lint | ||||
shiftkey marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
uses: mattpage/[email protected] | ||||
with: | ||||
# TODO: use matrix.files variable when workflow is ready to process 3.1 files | ||||
entrypoints: 'descriptions/**/*.yaml' | ||||
config: '.redocly.yml' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules/ |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.