doc: Update document. #147
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: | |
| - main | |
| # paths-ignore: | |
| # - '.github/**/*.yml' | |
| jobs: | |
| build-deploy: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| registry-url: 'https://registry.npmjs.org' | |
| - run: npm install | |
| - run: npm run build | |
| - run: npm run bundle | |
| - run: npm run bundle:min | |
| - run: npm run doc | |
| - working-directory: core | |
| run: | | |
| npm run type-check | |
| - name: Generate Contributors Images | |
| uses: jaywcjlove/github-action-contributors@main | |
| with: | |
| filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
| output: www/build/CONTRIBUTORS.svg | |
| avatarSize: 42 | |
| - name: Create Tag | |
| id: create_tag | |
| uses: jaywcjlove/create-tag-action@main | |
| with: | |
| package-path: ./core/package.json | |
| - name: get tag version | |
| id: tag_version | |
| uses: jaywcjlove/changelog-generator@main | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v4 | |
| if: github.ref == 'refs/heads/main' | |
| with: | |
| commit_message: ${{steps.tag_version.outputs.tag}} ${{ github.event.head_commit.message }} | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./www/build | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' | |
| - name: Generate Changelog | |
| id: changelog | |
| uses: jaywcjlove/changelog-generator@main | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| head-ref: ${{steps.create_tag.outputs.version}} | |
| filter-author: (renovate-bot|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: | |
| allowUpdates: true | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| name: ${{ steps.create_tag.outputs.version }} | |
| tag: ${{ steps.create_tag.outputs.version }} | |
| body: | | |
| [](https://jaywcjlove.github.io/#/sponsor) [](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-heat-map@${{steps.create_tag.outputs.versionNumber}}/file/README.md) [](https://github.com/uiwjs/react-heat-map/releases) [](https://github.com/uiwjs/react-heat-map/network) [](https://github.com/uiwjs/react-heat-map/stargazers) [](https://github.com/uiwjs/react-heat-map/releases) [](https://bundlephobia.com/result?p=@uiw/react-heat-map@${{steps.create_tag.outputs.versionNumber}}) | |
| ```bash | |
| npm i @uiw/react-heat-map@${{steps.create_tag.outputs.versionNumber}} | |
| ``` | |
| ${{ steps.changelog.outputs.compareurl }} | |
| ${{ steps.changelog.outputs.changelog }} | |
| - name: 📦 @uiw/react-heat-map publish to NPM | |
| run: npm publish --access public --provenance | |
| continue-on-error: true | |
| working-directory: core | |
| env: | |
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |