diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml new file mode 100644 index 00000000..85afc979 --- /dev/null +++ b/.github/workflows/build_docs.yaml @@ -0,0 +1,78 @@ +# Copyright 2025-present Alibaba Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: "Publish Docs" + +on: + push: + branches: + - main + paths: + - 'apidoc/**' + - 'docs/**' + - 'src/**' + - 'include/**' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: false + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-24.04 + + steps: + - uses: actions/checkout@v6.0.1 + with: + fetch-depth: 1 + + - uses: actions/setup-python@v6 + with: + python-version: '3.x' + + - name: Install dependencies + run: | + sudo apt-get update + sudo apt-get install -y doxygen + make install-deps + + - name: Build API + run: | + cd ./apidoc + doxygen + cd - + + - name: Build Docs + run: | + cd docs + make html + mkdir -p /tmp/site + cp -r ./_build/html/* /tmp/site/ + cd - + + - name: Deploy to gh-pages + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + run: | + git config --global user.name 'GitHub Actions' + git config --global user.email 'actions@github.com' + + git checkout --orphan gh-pages-tmp + git rm --quiet -rf . + cp -r /tmp/site/* . + git add --all + git commit -m "Publish docs from commit ${{ github.sha }}" + git push -f origin gh-pages-tmp:gh-pages diff --git a/.github/workflows/clang_test.yaml b/.github/workflows/clang_test.yaml index 246b16ed..4f98e761 100644 --- a/.github/workflows/clang_test.yaml +++ b/.github/workflows/clang_test.yaml @@ -1,4 +1,4 @@ -# Copyright 2024-present Alibaba Inc. +# Copyright 2025-present Alibaba Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -29,9 +29,6 @@ concurrency: permissions: contents: read -env: - PAIMON_HOME: /tmp/paimon - jobs: ubuntu: name: AMD64 Ubuntu 24.04 diff --git a/.github/workflows/gcc_test.yaml b/.github/workflows/gcc_test.yaml index f07bdbd2..de4a3b24 100644 --- a/.github/workflows/gcc_test.yaml +++ b/.github/workflows/gcc_test.yaml @@ -29,9 +29,6 @@ concurrency: permissions: contents: read -env: - PAIMON_HOME: /tmp/paimon - jobs: ubuntu: name: AMD64 Ubuntu 24.04 diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml index 45f0a6ed..df70d9ba 100644 --- a/.github/workflows/pre-commit.yaml +++ b/.github/workflows/pre-commit.yaml @@ -1,4 +1,4 @@ -# Copyright 2024-present Alibaba Inc. +# Copyright 2025-present Alibaba Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/.github/workflows/test_with_sanitizer.yaml b/.github/workflows/test_with_sanitizer.yaml index 24293320..002d53c1 100644 --- a/.github/workflows/test_with_sanitizer.yaml +++ b/.github/workflows/test_with_sanitizer.yaml @@ -1,4 +1,4 @@ -# Copyright 2024-present Alibaba Inc. +# Copyright 2025-present Alibaba Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -29,9 +29,6 @@ concurrency: permissions: contents: read -env: - PAIMON_HOME: /tmp/paimon - jobs: ubuntu: name: AMD64 Ubuntu 24.04 diff --git a/docs/source/implementations/basic_concepts.rst b/docs/source/implementations/basic_concepts.rst index 690cd8c9..87d1c60a 100644 --- a/docs/source/implementations/basic_concepts.rst +++ b/docs/source/implementations/basic_concepts.rst @@ -19,10 +19,10 @@ .. https://github.com/apache/paimon/blob/master/docs/content/concepts/basic-concepts.md Basic Concepts -========================== +========================= File Layouts --------------------------- +------------------------- All files of a table are stored under one base directory. Paimon files are organized in a layered style. The following image illustrates the file layout. Starting from a snapshot file, Paimon readers can recursively access all records