add more doc about end to end canary update #559
Workflow file for this run
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: documentation | |
| on: | |
| pull_request: | |
| branches: | |
| - master | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| checks: | |
| if: github.event_name != 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: '16.15.x' | |
| - name: Test Build | |
| run: | | |
| if [ -e yarn.lock ]; then | |
| yarn install --frozen-lockfile | |
| elif [ -e package-lock.json ]; then | |
| npm ci | |
| else | |
| npm i | |
| fi | |
| npm run build | |
| gh-release: | |
| if: github.event_name != 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: '16.15.x' | |
| - uses: webfactory/ssh-agent@v0.5.0 | |
| with: | |
| ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }} | |
| - name: Release to GitHub Pages | |
| env: | |
| USE_SSH: true | |
| GIT_USER: git | |
| DEPLOYMENT_BRANCH: gh-pages | |
| run: | | |
| git config --global user.email "actions@github.com" | |
| git config --global user.name "gh-actions" | |
| yarn add nodejieba | |
| if [ -e yarn.lock ]; then | |
| yarn install --frozen-lockfile | |
| elif [ -e package-lock.json ]; then | |
| npm ci | |
| else | |
| npm i | |
| fi | |
| npm run build | |
| #find ./build -type f -name "*.html" -exec sed -i 's/src="\/img\//src="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages\/img\//g' {} + | |
| #find ./build -type f -name "*.html" -exec sed -i 's/src="\/zh\/img\//src="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages\/zh\/img\//g' {} + | |
| #find ./build -type f -name "*.html" -exec sed -i 's/src="\/assets\//src="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages\/assets\//g' {} + | |
| #find ./build -type f -name "*.html" -exec sed -i 's/src="\/zh\/assets\//src="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages\/zh\/assets\//g' {} + | |
| #find ./build -type f -name "*.html" -exec sed -i 's/href="\/assets\//href="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages\/assets\//g' {} + | |
| #find ./build -type f -name "*.html" -exec sed -i 's/href="\/zh\/assets\//href="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages\/zh\/assets\//g' {} + | |
| #find ./build -type f -name "*.js" -exec sed -i 's/n.Z=r.p+"assets/n.Z="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages"+r.p+"assets/g' {} + | |
| #find ./build -type f -name "*.js" -exec sed -i 's/r.setAttribute("rel","prefetch")/e="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages"+e;r.setAttribute("rel","prefetch")/g' {} + | |
| #find ./build -type f -name "*.js" -exec sed -i 's/.src=e/.src="https:\/\/cdn.jsdelivr.net\/gh\/openkruise\/openkruise.io@gh-pages"+e/g' {} + | |
| npm run deploy -- $(pwd) --out-dir build --skip-build true | |
| typo-check: | |
| if: github.event_name != 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: TypoCheck | |
| run: | | |
| pip3 install bs4 markdown html2markdown language_tool_python | |
| python3 .github/workflows/diff.py | |
| struct-check: | |
| if: github.event_name != 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - uses: actions/setup-go@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: StructCheck | |
| run: | | |
| cd .github/workflows && python3 version_struct_check.py |