doc: Update README.md #285
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: Build | |
| on: | |
| push: | |
| branches: | |
| - master | |
| 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 checked | |
| - run: npm run coverage | |
| - run: npm run example | |
| - run: npm run example:templates | |
| - run: cp -rf test/example/dist coverage/example | |
| - run: cp -rf test/templates/dist coverage/templates | |
| - name: Create idoc config. | |
| run: | | |
| cat > idoc.yml << EOF | |
| site: "SVG To Font {{version}}" | |
| menus: | |
| Home: index.html | |
| EOF | |
| - run: npm install idoc@1 -g | |
| - run: idoc --output coverage | |
| # - name: Converts Markdown to HTML | |
| # uses: jaywcjlove/markdown-to-html-cli@main | |
| # with: | |
| # output: coverage/index.html | |
| # github-corners: https://github.com/jaywcjlove/svgtofont.git | |
| - uses: jaywcjlove/coverage-badges-cli@main | |
| - name: Generate Contributors Images | |
| uses: jaywcjlove/github-action-contributors@main | |
| with: | |
| filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
| avatarSize: 42 | |
| output: coverage/CONTRIBUTORS.svg | |
| - name: Create Tag | |
| id: create_tag | |
| uses: jaywcjlove/create-tag-action@main | |
| with: | |
| package-path: ./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: ./coverage | |
| - 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: '[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://jaywcjlove.github.io/#/sponsor) [](https://uiwjs.github.io/npm-unpkg/#/pkg/svgtofont@${{steps.create_tag.outputs.versionNumber}}/file/README.md) [](https://bundlephobia.com/result?p=svgtofont@${{steps.create_tag.outputs.versionNumber}}) [](https://www.npmjs.com/package/svgtofont) | |
| Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/svgtofont/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html | |
| Comparing Changes: ${{ steps.changelog.outputs.compareurl }} | |
| ```bash | |
| npm i svgtofont | |
| ``` | |
| ${{ steps.changelog.outputs.changelog }} | |
| # - name: 📦 svgtofont publish to NPM | |
| # uses: JS-DevTools/npm-publish@v1 | |
| # with: | |
| # token: ${{ secrets.NPM_TOKEN }} | |
| # package: ./package.json | |
| - name: 📦 svgtofont publish to NPM | |
| run: npm publish --access public --provenance | |
| continue-on-error: true | |
| env: | |
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |