doc: update README.md #171
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 | |
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 type-check | |
- run: npm run coverage | |
- name: Create idoc config | |
run: | | |
cat > idoc.yml << EOF | |
site: "rehype-attr {{version}}" | |
menus: | |
Attr: index.html | |
Ignore: https://jaywcjlove.github.io/rehype-ignore/ | |
Rewrite: https://jaywcjlove.github.io/rehype-rewrite/ | |
Video: https://jaywcjlove.github.io/rehype-video/ | |
Sponsor: https://jaywcjlove.github.io/#/sponsor | |
footer: | | |
<a href="https://wangchujiang.com/#/contact" target="_blank">Contact</a> • | |
<a href="https://wangchujiang.com/#/projects" target="_blank">Projects</a> • | |
<a href="https://wangchujiang.com/#/sponsor" target="_blank">Sponsor</a> • | |
<a href="https://wangchujiang.com/#/app" target="_blank">More Apps</a><br /><br /> | |
Generated by <a href="https://github.com/jaywcjlove/idoc" target="_blank">idoc</a> v{{idocVersion}} | |
EOF | |
- run: npm install idoc@1 -g | |
- run: idoc | |
- run: cp -rp ./coverage/lcov-report dist | |
- uses: jaywcjlove/coverage-badges-cli@main | |
with: | |
output: dist/badges.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: Generate Contributors Images | |
uses: jaywcjlove/github-action-contributors@main | |
with: | |
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
output: dist/CONTRIBUTORS.svg | |
avatarSize: 42 | |
- 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: ./dist | |
- name: Generate Changelog | |
id: changelog | |
uses: jaywcjlove/changelog-generator@main | |
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: | | |
[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor) [![](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/rehype-attr@${{steps.create_tag.outputs.versionNumber}}/file/README.md) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/rehype-attr)](https://bundlephobia.com/result?p=rehype-attr@${{steps.create_tag.outputs.versionNumber}}) | |
Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/rehype-attr/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html | |
Comparing Changes: ${{ steps.changelog.outputs.compareurl }} | |
```bash | |
npm i rehype-attr@${{steps.create_tag.outputs.versionNumber}} | |
``` | |
${{ steps.changelog.outputs.changelog }} | |
- run: npm publish --access public --provenance | |
continue-on-error: true | |
env: | |
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |