Skip to content

Commit

Permalink
Update readme and CI (#348)
Browse files Browse the repository at this point in the history
* build: update github-actions with dependabot

* docs(readme): add snyk badge

* docs(readme): update http links to https

* docs(readme): remove mention of openapi v3 being unsupported

* chore: reduce size of test script

* ci: add coverage generation and badge

* style: sort scripts alphabetically

* chore: remove coverage threshold to pass ci
  • Loading branch information
Fdawgs committed Feb 2, 2021
1 parent aa496a9 commit 9f92400
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 9 deletions.
8 changes: 6 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
version: 2
updates:
- package-ecosystem: npm
- package-ecosystem: github-actions
directory: '/'
schedule:
interval: daily
open-pull-requests-limit: 10

- package-ecosystem: npm
directory: '/'
schedule:
interval: daily
open-pull-requests-limit: 10
18 changes: 17 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,23 @@ jobs:
- name: Prepare
run: npm run prepare
- name: Test
run: npm test
run: npm run test:ci
- name: Coveralls Parallel
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.github_token }}
parallel: true
flag-name: run-${{ matrix.node-version }}-${{ matrix.os }}

coverage:
needs: test
runs-on: ubuntu-latest
steps:
- name: Coveralls Finished
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
parallel-finished: true

automerge:
needs: test
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# fastify-swagger

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) ![CI workflow](https://github.com/fastify/fastify-swagger/workflows/CI%20workflow/badge.svg)
![CI workflow](https://github.com/fastify/fastify-swagger/workflows/CI%20workflow/badge.svg)
[![Known Vulnerabilities](https://snyk.io/test/github/fastify/fastify-swagger/badge.svg)](https://snyk.io/test/github/fastify/fastify-swagger)
[![Coverage Status](https://coveralls.io/repos/github/fastify/fastify-swagger/badge.svg?branch=master)](https://coveralls.io/github/fastify/fastify-swagger?branch=master)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)

[Swagger](https://swagger.io/) documentation generator for Fastify.
It uses the schemas you declare in your routes to generate a swagger compliant doc.
Expand Down Expand Up @@ -304,8 +307,7 @@ fastify.route({
minItems: 1,
//
// Note that this is an Open API version 2 configuration option. The
// options changed in version 3. The plugin currently only supports
// version 2 of Open API.
// options changed in version 3.
//
// Put `collectionFormat` on the same property which you are defining
// as an array of values. (i.e. `collectionFormat` should be a sibling
Expand Down Expand Up @@ -378,8 +380,8 @@ In that case checkout [fastify-swaggergen](https://github.com/seriousme/fastify-
## Acknowledgements
This project is kindly sponsored by:
- [nearForm](http://nearform.com)
- [LetzDoIt](http://www.letzdoitapp.com/)
- [nearForm](https://nearform.com)
- [LetzDoIt](https://www.letzdoitapp.com/)
<a name="license"></a>
## License
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
"main": "index.js",
"scripts": {
"prepare": "node lib/util/prepare-swagger-ui",
"test": "standard && tap --100 test/*.js test/spec/**/*.js test/mode/*.js test/esm/*.js && npm run typescript",
"prepublishOnly": "npm run prepare",
"test": "standard && tap --100 test/**/*.js && npm run typescript",
"test:ci": "standard && tap test/**/*.js --coverage-report=lcovonly && npm run typescript",
"typescript": "tsd"
},
"repository": {
Expand Down

0 comments on commit 9f92400

Please sign in to comment.