Merge branch 'main' into xxchan/latest-nightly-rust

.cargo/config.toml

@@ -32,3 +32,11 @@ rustflags = [
 # Flags for all targets.
 [target.'cfg(all())']
 rustflags = ["--cfg", "tokio_unstable"]
+
+# We have large git dependencies. This can make cloning faster.
+# https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#git
+# Actually we also want to prevent submodule cloning completely
+# https://github.com/rust-lang/cargo/issues/4247
+[unstable.git]
+shallow_index = true
+shallow_deps = true

.github/workflows/doc.yml

@@ -25,28 +25,28 @@ jobs:
           remove-docker-images: 'true'
           root-reserve-mb: 10240
           temp-reserve-mb: 10240
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Rust toolchain
         run: rustup show
-      - name: Install dependencies
+      - name: Install dependencies for compiling RisingWave
         run: sudo apt-get update && sudo apt-get install -y make build-essential cmake protobuf-compiler curl openssl libssl-dev libsasl2-dev libcurl4-openssl-dev pkg-config postgresql-client tmux lld
       - name: Run sccache-cache
-        uses: mozilla-actions/[email protected].3
+        uses: mozilla-actions/[email protected].5
         with:
           version: "v0.5.2"
       - name: build rustdocs
         run: |
           cargo doc --workspace --no-deps --document-private-items
           cp docs/rustdoc/rust.css target/doc/rust.css
 
-          mkdir artifact
-          cp -R target/doc/* artifact
+          mkdir -p artifact/rustdoc
+          cp -R target/doc/* artifact/rustdoc
       - name: Show available storage
         run: df -h
-      - name: Install cargo-docset
+      - name: Install tools for building docs
         uses: taiki-e/install-action@v2
         with:
-          tool: cargo-docset
+          tool: cargo-docset,mdbook,mdbook-toc,mdbook-linkcheck
       - name: build docsets
         run: |
           cargo docset --no-clean --docset-name RisingWave
@@ -58,8 +58,13 @@ jobs:
           </entry>" > RisingWave.xml
 
           cp -t artifact "risingwave.docset.tgz" "RisingWave.xml"
+      - name: build developer doc
+        run: |
+          cd docs/dev
+          mdbook build
+          cp -R book/html/* ../../artifact
       - name: Upload artifacts
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: artifact
       - name: Show available storage
@@ -76,4 +81,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

.github/workflows/stale.yml

@@ -22,15 +22,15 @@ jobs:
     - uses: actions/stale@v9
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: >
+        stale-issue-message: |
           This issue has been open for 60 days with no activity.
 
           If you think it is still relevant today, and needs to be done *in the near future*, you can comment to update the status, or just manually remove the `no-issue-activity` label.
 
           You can also confidently close this issue as not planned to keep our backlog clean.
           Don't worry if you think the issue is still valuable to continue in the future.
           It's searchable and can be reopened when it's time. 😄
-        stale-pr-message: >
+        stale-pr-message: |
           This PR has been open for 60 days with no activity.
 
           If it's blocked by code review, feel free to ping a reviewer or ask someone else to review it.
@@ -40,13 +40,13 @@ jobs:
           You can also confidently close this PR to keep our backlog clean. (If no further action taken, the PR will be automatically closed after 7 days. Sorry!  🙏)
           Don't worry if you think the PR is still valuable to continue in the future.
           It's searchable and can be reopened when it's time. 😄
-        close-pr-message: >
+        close-pr-message: |
           Close this PR as there's no further actions taken after it is marked as stale for 7 days. Sorry! 🙏
 
           You can reopen it when you have time to continue working on it.
         stale-issue-label: 'no-issue-activity'
         stale-pr-label: 'no-pr-activity'
         days-before-close: -1
         days-before-pr-close: 7
-        operations-per-run: ${{ github.event.inputs.operationsPerRun }}
+        operations-per-run: ${{ github.event.inputs.operationsPerRun || 30 }}
         enable-statistics: true

.github/workflows/typo.yml

@@ -10,4 +10,4 @@ jobs:
       uses: actions/checkout@v3
 
     - name: Check spelling of the entire repository
-      uses: crate-ci/typos@v1.20.4
+      uses: crate-ci/typos@v1.23.2

.gitignore

@@ -81,3 +81,8 @@ e2e_test/iceberg/spark-*-bin*
 **/poetry.lock
 
 *.slt.temp
+
+.direnv/
+
+# mdbook
+book

.pre-commit-config.yaml

@@ -7,17 +7,17 @@ repos:
     hooks:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+-   repo: https://github.com/crate-ci/typos
+    rev: v1.23.1
+    hooks:
+      - id: typos
 -   repo: local
     hooks:
     -   id: rustfmt
         name: rustfmt
         entry: rustfmt --edition 2021
         language: system
         types: [rust]
-    -   id: typos
-        name: typos
-        entry: typos -w
-        language: system
     -   id: cargo sort
         name: cargo sort
         entry: cargo sort -g -w

.typos.toml

@@ -14,7 +14,9 @@ mosquitto = "mosquitto" # This is a MQTT broker.
 abd = "abd"
 iy = "iy"
 Pn = "Pn"
+
 [default.extend-identifiers]
+TABLE_SCHEM = "TABLE_SCHEM"
 
 [files]
 extend-exclude = [
@@ -25,8 +27,13 @@ extend-exclude = [
     "src/sqlparser/tests/testdata/",
     "src/frontend/planner_test/tests/testdata",
     "src/tests/sqlsmith/tests/freeze",
+    "src/license/src/manager.rs",
     "Cargo.lock",
     "**/Cargo.toml",
     "**/go.mod",
     "**/go.sum",
+    # https://github.com/risingwavelabs/risingwave/blob/0ce6228df6a4da183ae91146f2cdfff1ca9cc6a7/src/common/src/cast/mod.rs#L30
+    # We don't want to fix "fals" here, but may want in other places.
+    # Ideally, we should just ignore that line: https://github.com/crate-ci/typos/issues/316
+    "src/common/src/cast/mod.rs",
 ]

CONTRIBUTING.md

@@ -1,72 +1,16 @@
-# Contribution guidelines
+# Contributing to RisingWave
 
-Thanks for your interest in contributing to RisingWave! We welcome and appreciate contributions.
+Contributing documentation has moved to the **[RisingWave Developer Guide](https://risingwavelabs.github.io/risingwave/)**.
 
-This document describes how to submit your code changes. To learn about the development process, see the [developer guide](docs/developer-guide.md). To understand the design and implementation of RisingWave, refer to the design docs listed in [docs/README.md](docs/README.md).
 
-If you have questions, you can search for existing discussions or start a new discussion in the [Discussions forum of RisingWave](https://github.com/risingwavelabs/risingwave/discussions), or ask in the RisingWave Community channel on Slack. Please use the [invitation link](https://risingwave.com/slack) to join the channel.
+## Before hacking on RisingWave
 
-To report bugs, create a [GitHub issue](https://github.com/risingwavelabs/risingwave/issues/new/choose).
+We encourage people to discuss their design before hacking on code. Typically,
+you [file an issue] or start a thread on the [Community Slack] before submitting
+a pull request.
 
+Please read [the process] of how to submit your change to RisingWave.
 
-## Table of contents
-
-- [Contribution guidelines](#contribution-guidelines)
-  - [Table of contents](#table-of-contents)
-  - [Tests and miscellaneous checks](#tests-and-miscellaneous-checks)
-  - [Submit a PR](#submit-a-pr)
-    - [Pull Request title](#pull-request-title)
-    - [Pull Request description](#pull-request-description)
-    - [Sign the CLA](#sign-the-cla)
-    - [Cherry pick the commit to release candidate branch](#cherry-pick-the-commit-to-release-candidate-branch)
-
-## Tests and miscellaneous checks
-
-Before submitting your code changes, ensure you fully test them and perform necessary checks. The testing instructions and necessary checks are detailed in the [developer guide](docs/developer-guide.md#test-your-code-changes).
-
-## Submit a PR
-
-### Pull Request title
-
-As described in [here](https://github.com/commitizen/conventional-commit-types/blob/master/index.json), a valid PR title should begin with one of the following prefixes:
-
-- `feat`: A new feature
-- `fix`: A bug fix
-- `doc`: Documentation only changes
-- `refactor`: A code change that neither fixes a bug nor adds a feature
-- `style`: A refactoring that improves code style
-- `perf`: A code change that improves performance
-- `test`: Adding missing tests or correcting existing tests
-- `build`: Changes that affect the build system or external dependencies (example scopes: `.config`, `.cargo`, `Cargo.toml`)
-- `ci`: Changes to RisingWave CI configuration files and scripts (example scopes: `.github`, `ci` (Buildkite))
-- `chore`: Other changes that don't modify src or test files
-- `revert`: Reverts a previous commit
-
-For example, a PR title could be:
-
-- `refactor: modify executor protobuf package path`
-- `feat(execution): enable comparison between nullable data arrays`, where `(execution)` means that this PR mainly focuses on the execution component.
-
-You may also check out previous PRs in the [PR list](https://github.com/risingwavelabs/risingwave/pulls).
-
-### Pull Request description
-
-- If your PR is small (such as a typo fix), you can go brief.
-- If it is large and you have changed a lot, it's better to write more details.
-
-### Sign the CLA
-
-Contributors will need to sign RisingWave Labs' CLA.
-
-### Cherry pick the commit to release candidate branch
-We have a GitHub Action to help cherry-pick commits from `main` branch to a `release candidate` branch, such as `v*.*.*-rc` where `*` is a number.
-
-Checkout details at: https://github.com/risingwavelabs/risingwave/blob/main/.github/workflows/cherry-pick-to-release-branch.yml
-
-To trigger the action, we give a correct label to the PR on `main` branch :
-https://github.com/risingwavelabs/risingwave/blob/main/.github/workflows/cherry-pick-to-release-branch.yml#L10
-
-It will act when the PR on `main` branch merged:
-- If `git cherry-pick` does not find any conflicts, it will open a PR to the `release candidate` branch, and assign the original author as the reviewer.
-
-- If there is a conflict, it will open an issue and make the original author the assignee.
+[Community Slack]: https://risingwave.com/slack
+[file an issue]: https://github.com/risingwavelabs/risingwave/issues/new/choose
+[the process]: https://risingwavelabs.github.io/risingwave/contribution