doc: Update README.md #275
This file contains 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
name: CI | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
build-deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-node@v3 | |
with: | |
node-version: 16 | |
registry-url: 'https://registry.npmjs.org' | |
- name: Look Changelog | |
uses: jaywcjlove/changelog-generator@main | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
filter-author: (小弟调调™|Renovate Bot) | |
filter: '[R|r]elease[d]\s+[v|V]\d(\.\d+){0,2}' | |
- run: yarn install | |
- run: yarn run build | |
- run: yarn run coverage | |
- run: yarn run doc | |
- run: npm i markdown-to-html-cli -g | |
- run: markdown-to-html -s packages/core/README.md --output packages/core/docs/index.html | |
- run: markdown-to-html -s README-zh.md --output packages/core/docs/index.zh.html | |
- run: npm run example:create-react-app | |
- run: npm run example:typescript | |
- run: npm run example:webpack | |
- name: Generate Contributors Images | |
uses: jaywcjlove/github-action-contributors@main | |
with: | |
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
output: ./packages/core/docs/CONTRIBUTORS.svg | |
avatarSize: 43 | |
- name: Is a tag created auto? | |
id: create_tag | |
uses: jaywcjlove/create-tag-action@main | |
with: | |
package-path: ./packages/core/package.json | |
- name: get tag version | |
id: tag_version | |
uses: jaywcjlove/changelog-generator@main | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
commit_message: ${{steps.tag_version.outputs.tag}} ${{ github.event.head_commit.message }} | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./packages/core/docs | |
- name: Generate Changelog | |
id: changelog | |
uses: jaywcjlove/changelog-generator@main | |
if: steps.create_tag.outputs.successful | |
with: | |
head-ref: ${{ steps.create_tag.outputs.version }} | |
filter-author: (小弟调调™|Renovate Bot) | |
filter: '[R|r]elease[d]\s+[v|V]\d(\.\d+){0,2}' | |
- name: Create Release | |
uses: ncipollo/release-action@v1 | |
if: steps.create_tag.outputs.successful | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
name: ${{ steps.create_tag.outputs.version }} | |
tag: ${{ steps.create_tag.outputs.version }} | |
body: | | |
[![](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/mocker-api@${{steps.create_tag.outputs.versionNumber}}/file/README.md) [![npm version](https://img.shields.io/npm/v/mocker-api.svg)](https://www.npmjs.com/package/mocker-api) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/mocker-api)](https://bundlephobia.com/result?p=mocker-api@${{steps.create_tag.outputs.versionNumber}}) | |
Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/mocker-api/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html | |
Comparing Changes: ${{ steps.changelog.outputs.compareurl }} | |
```bash | |
npm i mocker-api@${{steps.create_tag.outputs.versionNumber}} | |
``` | |
${{ steps.changelog.outputs.changelog }} | |
- run: npm publish | |
continue-on-error: true | |
working-directory: packages/core | |
env: | |
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | |
# - uses: JS-DevTools/npm-publish@v1 | |
# with: | |
# token: ${{ secrets.NPM_TOKEN }} | |
# package: ./packages/core/package.json | |
# - run: npm install @jsdevtools/npm-publish -g | |
# - run: npm-publish --token="${{ secrets.NPM_TOKEN }}" ./packages/core/package.json |