doc: Update README.md #44
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 & Deploy | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
build-deploy: | |
runs-on: ubuntu-latest | |
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: mkdir -p docs | |
- run: npm install [email protected] typescript -g | |
- run: typedoc src/server.ts --name sgo --out docs/type | |
- run: cp -rp img docs | |
- run: npm i markdown-to-html-cli -g | |
- run: markdown-to-html --output docs/index.html | |
- run: markdown-to-html --source README-zh.md --output docs/index.zh.html | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs | |
- name: Is a tag created auto? | |
id: create_tag | |
uses: jaywcjlove/create-tag-action@main | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
package-path: ./package.json | |
- 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) | |
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: | |
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/sgo@${{steps.create_tag.outputs.versionNumber}}/file/README.md) | |
```bash | |
npm i sgo@${{steps.create_tag.outputs.versionNumber}} | |
``` | |
${{ steps.changelog.outputs.compareurl }} | |
${{ steps.changelog.outputs.changelog }} | |
# - run: npm install @jsdevtools/npm-publish -g | |
# - run: npm-publish --token="${{ secrets.NPM_TOKEN }}" ./package.json | |
- run: npm publish --access public | |
name: 📦 sgo publish to NPM | |
continue-on-error: true | |
env: | |
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |