[Doc] Revise Backup Restore according to feedback (backport #53738) #55903
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: CI DOC Checker | |
| on: | |
| pull_request_target: | |
| types: | |
| - opened | |
| - synchronize | |
| branches: | |
| - main | |
| - 'branch*' | |
| permissions: | |
| issues: write | |
| pull-requests: write | |
| jobs: | |
| doc-checker: | |
| runs-on: ubuntu-latest | |
| name: DOC FILTER | |
| if: > | |
| !contains(github.event.pull_request.title, '(sync #') && | |
| !contains(github.event.pull_request.labels.*.name, 'sync') && | |
| (!startsWith(github.head_ref, github.base_ref) || !contains(github.head_ref, '-sync-')) | |
| outputs: | |
| output1: ${{ steps.doc-changes-info.outputs.doc }} | |
| steps: | |
| <<<<<<< HEAD | |
| - uses: dorny/paths-filter@v2 | |
| ======= | |
| - uses: dorny/paths-filter@v3 | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| id: changes | |
| with: | |
| filters: | | |
| doc: | |
| - 'docs/**' | |
| - name: DOC CHECK INFO | |
| id: doc-changes-info | |
| run: | | |
| echo "doc=${{ steps.changes.outputs.doc }}" >> $GITHUB_OUTPUT | |
| remove-doc-label: | |
| needs: doc-checker | |
| runs-on: ubuntu-latest | |
| name: REMOVE DOC LABEL | |
| if: ${{ needs.doc-checker.outputs.output1 != 'true' }} | |
| steps: | |
| - name: remove document label | |
| uses: actions-ecosystem/action-remove-labels@v1 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| labels: documentation | |
| add-doc-label: | |
| needs: doc-checker | |
| runs-on: ubuntu-latest | |
| name: ADD DOC LABEL | |
| if: ${{ needs.doc-checker.outputs.output1 == 'true' }} | |
| steps: | |
| - name: add document label | |
| uses: actions-ecosystem/action-add-labels@v1 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| labels: documentation | |
| markdownlint: | |
| runs-on: ubuntu-latest | |
| needs: add-doc-label | |
| env: | |
| PR_NUMBER: ${{ github.event.number }} | |
| steps: | |
| - name: clean | |
| run: | | |
| rm -rf ${{ github.workspace }} | |
| mkdir -p ${{ github.workspace }} | |
| - name: BRANCH INFO | |
| id: branch | |
| run: | | |
| echo ${{github.base_ref}} | |
| echo "branch=${{github.base_ref}}" >> $GITHUB_OUTPUT | |
| <<<<<<< HEAD | |
| - uses: actions/checkout@v3 | |
| ======= | |
| - uses: actions/checkout@v4 | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| with: | |
| fetch-depth: 0 | |
| - name: Checkout PR | |
| run: | | |
| BRANCH=${{steps.branch.outputs.branch}} | |
| git config --global user.name "wanpengfei-git"; | |
| git config --global user.email "[email protected]"; | |
| git checkout $BRANCH; | |
| git pull; | |
| BRANCH_NAME="${BRANCH}-${PR_NUMBER}"; | |
| git fetch origin pull/${PR_NUMBER}/head:${BRANCH_NAME}; | |
| git checkout $BRANCH_NAME; | |
| git checkout -b merge_pr; | |
| <<<<<<< HEAD | |
| git merge --squash --no-edit ${BRANCH} || (echo "Merge conflict, please check." && exit -1); | |
| ======= | |
| git merge --squash --no-edit ${BRANCH} || (echo "::error::Merge conflict, please check." && exit -1); | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| - uses: articulate/[email protected] | |
| with: | |
| config: "docs/.markdownlint.json" | |
| files: 'docs/**/*.md' | |
| ignore: node_modules | |
| version: 0.28.1 | |
| <<<<<<< HEAD | |
| ======= | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| - name: docusaurus-mdx-checker | |
| if: always() | |
| run: | | |
| npx docusaurus-mdx-checker -c docs | |
| <<<<<<< HEAD | |
| ======= | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| - name: link check | |
| if: always() | |
| uses: lycheeverse/[email protected] | |
| with: | |
| fail: true | |
| args: > | |
| --config docs/lychee.toml | |
| --offline "docs/**/*.md" | |
| - name: Docusaurus build | |
| env: | |
| <<<<<<< HEAD | |
| ======= | |
| NODE_OPTIONS: --max-old-space-size=8192 | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| DISABLE_VERSIONING: true | |
| working-directory: ./docs/docusaurus | |
| run: | | |
| rm -rf ./docs | |
| rm -rf ./i18n/zh/docusaurus-plugin-content-dos/current | |
| mkdir -p ./i18n/zh/docusaurus-plugin-content-docs | |
| mv ../en ./docs | |
| <<<<<<< HEAD | |
| mv ../zh ./i18n/zh/docusaurus-plugin-content-docs/current | |
| yarn install --frozen-lockfile | |
| ======= | |
| rm -rf ./docs/release_notes ./docs/ecosystem_release | |
| mv ../zh ./i18n/zh/docusaurus-plugin-content-docs/current | |
| rm -rf ./i18n/zh/docusaurus-plugin-content-docs/current/release_notes ./i18n/zh/docusaurus-plugin-content-docs/current/ecosystem_release | |
| yarn install --frozen-lockfile | |
| yarn clear | |
| >>>>>>> edd5009ce6 ([Doc] Revise Backup Restore according to feedback (#53738)) | |
| yarn build | |
| behavior-unchange: | |
| runs-on: ubuntu-latest | |
| needs: add-doc-label | |
| env: | |
| PR_NUMBER: ${{ github.event.number }} | |
| REPO: ${{ github.repository }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - name: Set Body | |
| run: | | |
| body=$(gh pr view ${PR_NUMBER} -R ${REPO} --json body -q .body) | |
| body=${body//"[x] Yes, this PR will result in a change in behavior."/"[ ] Yes, this PR will result in a change in behavior."} | |
| body=${body//"[ ] No, this PR will not result in a change in behavior."/"[x] No, this PR will not result in a change in behavior."} | |
| gh pr edit ${PR_NUMBER} -R ${REPO} -b "$body" |