doc: Update README.md #77
This file contains hidden or 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: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: 24 | |
| registry-url: 'https://registry.npmjs.org' | |
| - run: npm -v | |
| - run: npm install | |
| - run: npm run build | |
| - run: npm run doc | |
| - name: Generate Contributors Images | |
| uses: jaywcjlove/github-action-contributors@main | |
| with: | |
| filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
| output: ./website/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: Create README.md of Build | |
| working-directory: website/build | |
| run: | | |
| cat > README.md << EOF | |
| Preview the document `react-code-preview-layout@v3`: https://uiwjs.github.io/react-code-preview-layout/ | |
| Preview the document `react-code-preview-layout@v2`: https://raw.githack.com/uiwjs/react-code-preview-layout/doc2/index.html | |
| EOF | |
| - 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.tag_version.outputs.tag}} ${{ github.event.head_commit.message }} | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./website/build | |
| - name: Generate Changelog | |
| id: changelog | |
| uses: jaywcjlove/changelog-generator@main | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| filter-author: (jaywcjlove|小弟调调™|dependabot\[bot\]|Renovate Bot) | |
| filter: (^[\s]+?[R|r]elease)|(^[R|r]elease) | |
| - 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://uiwjs.github.io/npm-unpkg/#/pkg/react-code-preview-layout@${{steps.changelog.outputs.version}}/file/README.md) [](https://www.npmjs.com/package/react-code-preview-layout) | |
| Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/uiwjs/react-code-preview-layout/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html | |
| Comparing Changes: ${{ steps.changelog.outputs.compareurl }} | |
| ```bash | |
| npm i react-code-preview-layout@${{steps.changelog.outputs.version}} | |
| ``` | |
| ${{ steps.changelog.outputs.changelog }} | |
| - run: NODE_AUTH_TOKEN="" npm publish --access public --provenance | |
| name: 📦 react-code-preview-layout publish to NPM | |
| continue-on-error: true | |
| working-directory: core | |
| outputs: | |
| successful: ${{steps.create_tag.outputs.successful }} | |
| # github-package: | |
| # runs-on: ubuntu-latest | |
| # needs: build | |
| # if: needs.build.outputs.successful | |
| # steps: | |
| # - uses: actions/checkout@v3 | |
| # - uses: actions/setup-node@v3 | |
| # with: | |
| # node-version: 16 | |
| # registry-url: https://npm.pkg.github.com | |
| # scope: '@uiwjs' | |
| # - run: npm install | |
| # - run: npm run build | |
| # - name: Modify package name | |
| # working-directory: core | |
| # shell: bash | |
| # run: | | |
| # node -e 'var pkg = require("./package.json"); pkg.name="@uiwjs/react-code-preview-layout"; require("fs").writeFileSync("./package.json", JSON.stringify(pkg, null, 2))' | |
| # - run: npm publish | |
| # working-directory: core | |
| # env: | |
| # NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} |