Skip to content

Commit

Permalink
chore: doc and ci updates (#318)
Browse files Browse the repository at this point in the history
* ci: ignore documentation updates

* docs(readme): update http links to https

* ci: remove redundant conditional from automerge job

* ci: test on multiple os

* style(ci): use standardized template

* docs(readme): add badges
  • Loading branch information
Fdawgs committed Apr 13, 2021
1 parent 29e2e8e commit 4210cd8
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 18 deletions.
44 changes: 30 additions & 14 deletions .github/workflows/ci.yml
@@ -1,27 +1,43 @@
name: CI workflow
on: [push, pull_request]
name: CI

on:
push:
paths-ignore:
- 'docs/**'
- '*.md'
pull_request:
paths-ignore:
- 'docs/**'
- '*.md'

jobs:
test:
runs-on: ubuntu-latest
runs-on: ${{ matrix.os }}
strategy:
matrix:
node-version: [10.x, 12.x, 13.x, 14.x]
os: [macos-latest, ubuntu-latest, windows-latest]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2.1.5
with:
node-version: ${{ matrix.node-version }}
- name: Install Dependencies
run: npm install --ignore-scripts
- name: Test
run: npm run test
- uses: actions/checkout@v2

- name: Use Node.js
uses: actions/setup-node@v2.1.5
with:
node-version: ${{ matrix.node-version }}

- name: Install Dependencies
run: |
npm install --ignore-scripts
- name: Run Tests
run: |
npm run test
automerge:
needs: test
runs-on: ubuntu-latest
steps:
- uses: fastify/github-action-merge-dependabot@v2.0.0
if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request' }}
with:
github-token: ${{secrets.github_token}}
github-token: ${{ secrets.GITHUB_TOKEN }}
10 changes: 6 additions & 4 deletions README.md
@@ -1,7 +1,9 @@
# fast-json-stringify

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
![Ci Workflow](https://github.com/fastify/fast-json-stringify/workflows/CI%20workflow/badge.svg)
![CI](https://github.com/fastify/fast-json-stringify/workflows/CI/badge.svg)
[![NPM version](https://img.shields.io/npm/v/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)
[![Known Vulnerabilities](https://snyk.io/test/github/fastify/fast-json-stringify/badge.svg)](https://snyk.io/test/github/fastify/fast-json-stringify)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
[![NPM downloads](https://img.shields.io/npm/dm/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)


Expand Down Expand Up @@ -106,7 +108,7 @@ const stringify = fastJson(mySchema, {
<a name="fastJsonStringify"></a>
### fastJsonStringify(schema)

Build a `stringify()` function based on [jsonschema](http://json-schema.org/).
Build a `stringify()` function based on [jsonschema](https://json-schema.org/).

Supported types:

Expand Down Expand Up @@ -641,7 +643,7 @@ console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"F
<a name="acknowledgements"></a>
## Acknowledgements

This project was kindly sponsored by [nearForm](http://nearform.com).
This project was kindly sponsored by [nearForm](https://nearform.com).

<a name="license"></a>
## License
Expand Down

0 comments on commit 4210cd8

Please sign in to comment.