Skip to content

chore: add github workflows and update asf yaml#144

Merged
JingsongLi merged 4 commits into
apache:mainfrom
lucasfang:migrate_14
Jul 9, 2026
Merged

chore: add github workflows and update asf yaml#144
JingsongLi merged 4 commits into
apache:mainfrom
lucasfang:migrate_14

Conversation

@lucasfang

Copy link
Copy Markdown
Contributor

PR Description

Purpose

Linked issue: close #xxx

This PR introduces GitHub CI workflows and aligns ASF repository settings with the new CI layout. It also updates build flags and documentation to match currently supported components.

Main changes in this PR:

  1. Add CI and release workflows under .github/workflows:
  • build_docs.yaml
  • build_release.yaml
  • clang_test.yaml
  • gcc8_test.yaml
  • gcc_test.yaml
  • license_check.yaml
  • pre-commit.yaml
  • test_with_sanitizer.yaml
  1. Update .asf.yaml:
  • Configure GitHub Pages branch/path for docs publication.
  • Tighten protected branch checks and PR review rules.
  • Adjust repository feature toggles and PR behavior options.
  1. Update build configuration:
  • Keep PAIMON_ENABLE_LUCENE disabled in CMake and fail fast when explicitly enabled.
  • Remove Jindo-related toggles/integration paths from top-level CMake wiring.
  • Update ci/scripts/build_paimon.sh defaults to align with the current component matrix.
  • Remove Jindo dependency build path from cmake_modules/ThirdpartyToolchain.cmake.
  1. Sync documentation with current support matrix:
  • Remove Lance/Jindo/Lumina references from build and concept docs where no longer applicable.
  • Update Sphinx project metadata in docs/source/conf.py.
  • Trim Lumina vector index section from global index user guide.

Tests

  • CI workflows are added and intended to validate:
  • pre-commit checks
  • gcc and clang build/test jobs
  • gcc8 compatibility job
  • sanitizer build/test job
  • license rat check
  • release build jobs
  • docs build and gh-pages publish

Manual/local verification notes:

  • CMake configuration fails as expected when PAIMON_ENABLE_LUCENE is set to ON.
  • Full remote workflow execution depends on GitHub Actions after merge/PR triggers.

API and Format

No public API change in include directory.
No storage format or protocol change.

Documentation

Documentation has been updated to reflect current component support and index capabilities.

Generative AI tooling

Generated-by: GitHub Copilot (GPT-5.3-Codex)

Copilot AI review requested due to automatic review settings July 9, 2026 03:38

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a GitHub Actions CI/release/docs workflow suite and updates ASF repository settings and project docs/build configuration to match the current supported component matrix (notably disabling Lucene and removing Jindo/Lumina/Lance mentions from docs and some build wiring).

Changes:

  • Added multiple GitHub Actions workflows for builds/tests/sanitizers, docs publishing, pre-commit, and license checking.
  • Updated build configuration/scripts to keep Lucene disabled and removed Jindo-related toolchain wiring.
  • Synced Sphinx/documentation content with the currently supported formats and index features.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
docs/source/user_guide/global_index.rst Removes Lumina vector index documentation section.
docs/source/conf.py Updates Sphinx project metadata and copyright year handling.
docs/source/building.rst Removes references to Lance/Jindo/Lumina build flags.
docs/source/build_system.rst Removes plugin list references for Lance/Jindo/Lumina.
docs/source/basic_concepts.rst Updates supported data file formats text.
CMakeLists.txt Disables Lucene via fail-fast when explicitly enabled; removes some options.
cmake_modules/ThirdpartyToolchain.cmake Removes Jindo SDK build/download logic.
ci/scripts/build_paimon.sh Updates CI build defaults (keeps Lucene OFF).
.github/workflows/test_with_sanitizer.yaml Adds sanitizer CI workflow.
.github/workflows/pre-commit.yaml Adds pre-commit workflow.
.github/workflows/license_check.yaml Adds Apache Rat license check workflow.
.github/workflows/gcc8_test.yaml Adds GCC 8 compatibility workflow.
.github/workflows/gcc_test.yaml Adds GCC build/test workflow.
.github/workflows/clang_test.yaml Adds Clang build/test (incl. clang-tidy) workflow.
.github/workflows/build_release.yaml Adds release build workflow matrix (clang/gcc).
.github/workflows/build_docs.yaml Adds docs build and gh-pages publish workflow.
.asf.yaml Updates ASF GitHub repo settings, gh-pages config, and branch protections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +29 to +32
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- uses: actions/setup-python@v6
- uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
Comment on lines +48 to +55
if grep "Files with unapproved licenses" rat-report.txt; then
echo "❌ Found files with unapproved licenses!"
cat rat-report.txt
exit 1
else
echo "✅ All files have approved licenses."
cat rat-report.txt
fi
Comment on lines +76 to +78
git checkout --orphan gh-pages-tmp
git rm --quiet -rf .
cp -r /tmp/site/. .
runs-on: ubuntu-24.04

steps:
- uses: actions/checkout@v6.0.1
Comment thread .asf.yaml Outdated
Comment on lines +41 to +48
- pre-commit
- gcc-test
- rat-license-check
- test-with-sanitizer
- clang-release
- gcc-release
- clang-test
- gcc8-test
Comment on lines 57 to +58
Data files are grouped by partitions. Currently, Paimon supports using parquet
(default), orc and lance as data file’s format.
(default) and orc as data file’s format.
Comment thread .asf.yaml Outdated

@lxy-9602 lxy-9602 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@JingsongLi JingsongLi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants