doc: Update README.md #102 #1135
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: | |
| if: github.repository == 'jaywcjlove/reference' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| - run: npm install | |
| - run: npm run build | |
| - run: cp -rp icons ./dist | |
| - name: Generate Contributors Images | |
| uses: jaywcjlove/github-action-contributors@main | |
| id: contributors | |
| with: | |
| filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) | |
| output: dist/CONTRIBUTORS.svg | |
| avatarSize: 42 | |
| - name: Modify CONTRIBUTING.md | |
| uses: jaywcjlove/github-action-modify-file-content@main | |
| with: | |
| path: CONTRIBUTING.md | |
| body: | | |
| ${{steps.contributors.outputs.htmlList}} | |
| - name: Modify README.md | |
| uses: jaywcjlove/github-action-modify-file-content@main | |
| with: | |
| path: README.md | |
| body: | | |
| ${{steps.contributors.outputs.htmlList}} | |
| - name: Create Tag | |
| id: create_tag | |
| uses: jaywcjlove/create-tag-action@main | |
| with: | |
| package-path: ./package.json | |
| - name: gh-pages README.md | |
| working-directory: dist | |
| run: | | |
| cat << "EOF" > README.md | |
| Website: https://jaywcjlove.github.io/reference | |
| ## Docker | |
| [](https://jaywcjlove.github.io/#/sponsor) [](https://hub.docker.com/r/wcjiang/reference) [](https://hub.docker.com/r/wcjiang/reference) [](https://hub.docker.com/r/wcjiang/reference) | |
| 轻松通过 `docker` 部署 `Quick Reference` 网站。 | |
| ```bash | |
| docker pull wcjiang/reference | |
| ``` | |
| ```bash | |
| docker run --name reference --rm -d -p 9667:3000 wcjiang/reference:latest | |
| # Or | |
| docker run --name reference -itd -p 9667:3000 wcjiang/reference:latest | |
| ``` | |
| 在浏览器中访问以下 URL | |
| ```bash | |
| http://localhost:9667/ | |
| ``` | |
| EOF | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| commit_message: ${{ github.event.head_commit.message }} | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./dist | |
| - name: Generate Changelog | |
| id: changelog | |
| uses: jaywcjlove/changelog-generator@main | |
| with: | |
| filter-author: (小弟调调™|\@github-actions-bot\@renovate-bot|dependabot|renovate\\[bot\\]|dependabot\\[bot\\]|Renovate Bot) | |
| filter: (^[\s]+?[R|r]elease)|(^[R|r]elease) | |
| - name: Create Release | |
| uses: jaywcjlove/create-tag-action@main | |
| if: steps.create_tag.outputs.successful | |
| with: | |
| package-path: ./package.json | |
| version: ${{steps.create_tag.outputs.version}} | |
| release: true | |
| prerelease: false | |
| draft: false | |
| body: | | |
| [](https://jaywcjlove.github.io/#/sponsor) | |
| Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/reference/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html | |
| Comparing Changes: ${{ steps.changelog.outputs.compareurl }} | |
| ${{ steps.changelog.outputs.changelog }} | |
| ## Docker | |
| [](https://hub.docker.com/r/wcjiang/reference) [](https://hub.docker.com/r/wcjiang/reference) [](https://hub.docker.com/r/wcjiang/reference) | |
| 轻松通过 `docker` 部署 `Quick Reference` 网站。 | |
| ```bash | |
| docker pull wcjiang/reference | |
| ``` | |
| ```bash | |
| docker run --name reference --rm -d -p 9667:3000 wcjiang/reference:latest | |
| # Or | |
| docker run --name reference -itd -p 9667:3000 wcjiang/reference:latest | |
| ``` | |
| 在浏览器中访问以下 URL | |
| ```bash | |
| http://localhost:9667/ | |
| ``` | |
| # Create Docker Image | |
| - uses: docker/setup-buildx-action@v3 | |
| - name: Login to Docker Hub | |
| uses: docker/login-action@v3 | |
| with: | |
| username: ${{ secrets.DOCKER_USER }} | |
| password: ${{ secrets.DOCKER_PASSWORD }} | |
| - run: docker buildx prune | |
| - name: Build and push image:latest | |
| uses: docker/build-push-action@v5 | |
| with: | |
| push: true | |
| context: . | |
| platforms: linux/amd64,linux/arm64 | |
| tags: wcjiang/reference:latest | |
| - name: Build and push image:tags | |
| uses: docker/build-push-action@v5 | |
| if: steps.create_tag.outputs.successful | |
| with: | |
| push: true | |
| context: . | |
| platforms: linux/amd64,linux/arm64 | |
| tags: wcjiang/reference:${{steps.changelog.outputs.version}} | |
| # # Create Docker Image in Github | |
| # - name: Login to the GitHub Container Registry | |
| # uses: docker/login-action@v2 | |
| # with: | |
| # registry: ghcr.io | |
| # username: ${{ github.actor }} | |
| # password: ${{ secrets.GITHUB_TOKEN }} | |
| # - name: Build and push image:latest | |
| # uses: docker/build-push-action@v3 | |
| # with: | |
| # push: true | |
| # context: . | |
| # platforms: linux/amd64,linux/arm64 | |
| # tags: ghcr.io/jaywcjlove/reference:latest | |
| # - name: Build and push image:tags | |
| # uses: docker/build-push-action@v3 | |
| # if: steps.create_tag.outputs.successful | |
| # with: | |
| # push: true | |
| # context: . | |
| # platforms: linux/amd64,linux/arm64 | |
| # tags: ghcr.io/jaywcjlove/reference:${{steps.changelog.outputs.version}} | |
| # # Create Docker Image in Github | |
| # - name: Login to GitHub registry | |
| # run: echo ${{ github.token }} | docker login ghcr.io -u ${{ github.actor }} --password-stdin | |
| # - name: Build docker image | |
| # run: docker build -t ghcr.io/jaywcjlove/reference:latest . | |
| # - name: Publish to GitHub registry | |
| # run: docker push ghcr.io/jaywcjlove/reference:latest | |
| # - name: Tag docker image (beta) and publish to GitHub registry | |
| # if: steps.create_tag.outputs.successful | |
| # run: | | |
| # echo "version: v${{ steps.changelog.outputs.version }}" | |
| # docker tag ghcr.io/jaywcjlove/reference:latest ghcr.io/jaywcjlove/reference:${{steps.changelog.outputs.version}} | |
| # docker push ghcr.io/jaywcjlove/reference:${{steps.changelog.outputs.version}} | |
| # # Create Docker Image | |
| # - name: Docker login | |
| # run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_PASSWORD }} | |
| # - name: Build reference image | |
| # run: docker image build -t reference . | |
| # - name: Tags & Push image(latest) | |
| # run: | | |
| # echo "DOCKER_USER: ${{ secrets.DOCKER_USER }}" | |
| # docker tag reference ${{ secrets.DOCKER_USER }}/reference:latest | |
| # docker push ${{ secrets.DOCKER_USER }}/reference:latest | |
| # - name: Tags & Push image | |
| # if: steps.create_tag.outputs.successful | |
| # run: | | |
| # echo "outputs.tag - ${{ steps.changelog.outputs.version }}" | |
| # docker tag reference ${{ secrets.DOCKER_USER }}/reference:${{steps.changelog.outputs.version}} | |
| # docker push ${{ secrets.DOCKER_USER }}/reference:${{steps.changelog.outputs.version}} |