diff --git a/.github/workflows/pull-request.yaml b/.github/workflows/pull-request.yaml new file mode 100644 index 00000000000..226eeb17845 --- /dev/null +++ b/.github/workflows/pull-request.yaml @@ -0,0 +1,37 @@ +name: PullRequestCI + +env: + # Force the stdout and stderr streams to be unbuffered + PYTHONUNBUFFERED: 1 + CI: false + +on: # yamllint disable-line rule:truthy + pull_request: + types: + - synchronize + - reopened + - opened + +# Cancel the previous wf run in PRs. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + DocsCheck: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: '20' # Adjust Node.js version as needed + cache: 'yarn' # Cache yarn dependencies + + - name: Install dependencies + run: yarn install --frozen-lockfile + + - name: Build + run: yarn build diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml deleted file mode 100644 index 22608a72f37..00000000000 --- a/.github/workflows/pull-request.yml +++ /dev/null @@ -1,54 +0,0 @@ -# Contact the folks in #dev-ci for this one, it looks like it -# is a partial copy of the CI checks from ClickHouse/ClickHouse - ---- -name: PullRequestCI - -env: - # Force the stdout and stderr streams to be unbuffered - PYTHONUNBUFFERED: 1 - -on: # yamllint disable-line rule:truthy - pull_request: - types: - - synchronize - - reopened - - opened - -# Cancel the previous wf run in PRs. -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: true - -jobs: - DocsCheck: - runs-on: [self-hosted, func-tester-aarch64] - steps: - - name: Set envs - run: | - cat >> "$GITHUB_ENV" << 'EOF' - TEMP_PATH=${{runner.temp}}/docs_check - REPO_COPY=${{runner.temp}}/docs_check/ClickHouse - EOF - - name: Clear repository - run: | - sudo rm -rf "$GITHUB_WORKSPACE" && mkdir "$GITHUB_WORKSPACE" - sudo rm -rf "$TEMP_PATH" && mkdir -p "$TEMP_PATH" - - name: Check out repository code - uses: actions/checkout@v4 - with: - repository: "ClickHouse/ClickHouse" - path: "ClickHouse" - ref: "master" - - name: Docs Check - run: | - cp -r "$GITHUB_WORKSPACE/ClickHouse" "$TEMP_PATH" - cd "$REPO_COPY/tests/ci" - python3 docs_check.py --force --docs-branch "$GITHUB_REF" - python3 finish_check.py - - name: Cleanup - if: always() - run: | - docker kill "$(docker ps -q)" ||: - docker rm -f "$(docker ps -a -q)" ||: - sudo rm -fr "$TEMP_PATH" diff --git a/contribute/style-guide.md b/contribute/style-guide.md index 7b694031df7..b16d26a66d3 100644 --- a/contribute/style-guide.md +++ b/contribute/style-guide.md @@ -2,7 +2,8 @@ In this document, you will find a number of style guidelines for writing ClickHouse documentation. As documentation is a collective effort, these guidelines are -intended to help all of us ensure quality and consistency across our documentation. +intended to help all of us ensure we maintain quality and consistency across our +documentation. ## YAML front matter