doc: update document. #89
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: Node.js CI | |
| on: push | |
| jobs: | |
| build: | |
| 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 | |
| working-directory: core | |
| - run: npm install idoc@1 -g | |
| - name: Create idoc config. | |
| working-directory: core | |
| run: | | |
| cat > idoc.yml << EOF | |
| site: "Auto Config Loader {{version}}" | |
| menus: | |
| Home: index.html | |
| Apps: | |
| url: https://wangchujiang.com/#/app | |
| target: __blank | |
| Sponsor: | |
| url: https://wangchujiang.com/#/sponsor | |
| target: __blank | |
| 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: idoc | |
| working-directory: core | |
| - run: npm run coverage && cp -rp coverage/lcov-report ./dist | |
| working-directory: core | |
| - name: Generate Contributors Images | |
| uses: jaywcjlove/github-action-contributors@main | |
| with: | |
| filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
| output: core/dist/CONTRIBUTORS.svg | |
| avatarSize: 42 | |
| - name: Create Coverage Badges | |
| uses: jaywcjlove/coverage-badges-cli@main | |
| with: | |
| source: core/coverage/coverage-summary.json | |
| output: core/dist/badges.svg | |
| - name: Is a tag created auto? | |
| id: create_tag | |
| uses: jaywcjlove/create-tag-action@main | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| package-path: core/package.json | |
| - name: Deploy Website | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' | |
| commit_message: ${{steps.create_tag.outputs.version}} ${{ github.event.head_commit.message }} | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./core/dist | |
| - name: Generate Changelog | |
| id: changelog | |
| uses: jaywcjlove/changelog-generator@main | |
| if: steps.create_tag.outputs.successful | |
| 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: package.json info | |
| uses: jaywcjlove/github-action-package@main | |
| with: | |
| path: core/package.json | |
| unset: scripts | |
| - run: npm publish --access public --provenance | |
| continue-on-error: true | |
| working-directory: core | |
| env: | |
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | |
| - 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/auto-config-loader@${{steps.create_tag.outputs.versionNumber}}/file/README.md) | |
| Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/auto-config-loader/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html | |
| ```bash | |
| npm i auto-config-loader@${{steps.create_tag.outputs.versionNumber}} | |
| ``` | |
| ${{ steps.changelog.outputs.compareurl }} | |
| ${{ steps.changelog.outputs.changelog }} |