Skip to content

Commit 4210cd8

Browse files
authored
chore: doc and ci updates (#318)
* 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
1 parent 29e2e8e commit 4210cd8

File tree

2 files changed

+36
-18
lines changed

2 files changed

+36
-18
lines changed

.github/workflows/ci.yml

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
1-
name: CI workflow
2-
on: [push, pull_request]
1+
name: CI
2+
3+
on:
4+
push:
5+
paths-ignore:
6+
- 'docs/**'
7+
- '*.md'
8+
pull_request:
9+
paths-ignore:
10+
- 'docs/**'
11+
- '*.md'
12+
313
jobs:
414
test:
5-
runs-on: ubuntu-latest
15+
runs-on: ${{ matrix.os }}
616
strategy:
717
matrix:
818
node-version: [10.x, 12.x, 13.x, 14.x]
19+
os: [macos-latest, ubuntu-latest, windows-latest]
20+
921
steps:
10-
- uses: actions/checkout@v2
11-
- name: Use Node.js ${{ matrix.node-version }}
12-
uses: actions/[email protected]
13-
with:
14-
node-version: ${{ matrix.node-version }}
15-
- name: Install Dependencies
16-
run: npm install --ignore-scripts
17-
- name: Test
18-
run: npm run test
22+
- uses: actions/checkout@v2
23+
24+
- name: Use Node.js
25+
uses: actions/[email protected]
26+
with:
27+
node-version: ${{ matrix.node-version }}
28+
29+
- name: Install Dependencies
30+
run: |
31+
npm install --ignore-scripts
32+
33+
- name: Run Tests
34+
run: |
35+
npm run test
1936
2037
automerge:
2138
needs: test
2239
runs-on: ubuntu-latest
2340
steps:
2441
- uses: fastify/[email protected]
25-
if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request' }}
2642
with:
27-
github-token: ${{secrets.github_token}}
43+
github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# fast-json-stringify
22

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

79

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

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

111113
Supported types:
112114

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

644-
This project was kindly sponsored by [nearForm](http://nearform.com).
646+
This project was kindly sponsored by [nearForm](https://nearform.com).
645647

646648
<a name="license"></a>
647649
## License

0 commit comments

Comments
 (0)