This is an automated email from the ASF dual-hosted git repository.
xushiyan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hudi-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 691811a chore: add `CHANGELOG.md` with git-cliff config (#69)
691811a is described below
commit 691811a9a7b3ea272b8acd301bcee97ae7eae254
Author: Shiyan Xu <[email protected]>
AuthorDate: Wed Jul 17 00:39:19 2024 -0500
chore: add `CHANGELOG.md` with git-cliff config (#69)
---
CHANGELOG.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++
cliff.toml | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 208 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..de82b8a
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,91 @@
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+-->
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2024-07-15
+
+### ๐ Features
+
+- Initial rust implementation to integrate with datafusion (#1) by @xushiyan
+- Add python binding (#21) by @xushiyan
+- Implement `HudiTable` as python API (#23) by @xushiyan
+- Use `object_store` for common storage APIs (#25) by @xushiyan
+- Implement Rust and Python APIs to read file slices (#28) by @xushiyan
+- Add APIs for time-travel read (#33) by @xushiyan
+- Implement datafusion API using ParquetExec (#35) by @xushiyan
+- Add `HudiConfigs` for parsing and managing named configs (#37) by @xushiyan
+- Add config validation when creating table (#49) by @xushiyan
+- Add internal config to skip validation (#51) by @xushiyan
+- Support time travel with read option (#52) by @xushiyan
+- Support taking env vars for cloud storages (#55) by @xushiyan
+
+### ๐ Bug Fixes
+
+- Handle replacecommit for loading file slices (#53) by @xushiyan
+
+### ๐ Refactor
+
+- Use `anyhow` for generic errors (#26) by @xushiyan
+- Use `object_store` API for Timeline (#27) by @xushiyan
+- Make APIs async (#31) by @xushiyan
+- Improve thread safety and error handling (#32) by @xushiyan
+- Improve error handling in storage module (#34) by @xushiyan
+- Adjust table APIs to skip passing options (#56) by @xushiyan
+
+### ๐ Documentation
+
+- Update readme, contributing guide, and issue template (#57) by @xushiyan
+- Update CONTRIBUTING with minor changes (#58) by @codope
+
+### ๐จ Styling
+
+- Enforce rust code style (#14) by @xushiyan
+
+### ๐ ๏ธ Build
+
+- Clean up and trim down dependencies (#54) by @xushiyan
+- Add info for rust and python artifacts (#60) by @xushiyan
+- Add release workflow (#63) by @xushiyan
+
+### ๐งช Testing
+
+- Add tests crate and adopt testing tables (#30) by @xushiyan
+- Add test cases for different table setup (#36) by @xushiyan
+
+### โ๏ธ Miscellaneous Tasks
+
+- Setup ci for license file and headers (#2) by @xushiyan
+- Fix failing check and test case (#10) by @xushiyan
+- Fix asf notification (#11) by @xushiyan
+- Add commit linting (#12) by @xushiyan
+- Use cargo tarpaulin to generate code coverage (#15) by @xushiyan
+- Remove codecov to keep ci green (#17) by @xushiyan
+- Fix codecov setup (#20) by @xushiyan
+- Configure codecov (#50) by @xushiyan
+- Add scripts to streamline source release (#64) by @xushiyan
+
+## New Contributors
+
+* @codope made their first contribution in #58
+* @xushiyan made their first contribution in #1
+
+<!-- generated by git-cliff -->
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 0000000..6060714
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,117 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog footer
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+ ## [{{ version | trim_start_matches(pat="release-") }}] - {{ timestamp |
date(format="%Y-%m-%d") }}
+{% else %}\
+ ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+ ### {{ group | striptags | trim | upper_first }}
+ {% for commit in commits %}
+ - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+ {% if commit.breaking %}[**breaking**] {% endif %}\
+ {{ commit.message | upper_first }}\
+ {% if commit.github.username %} by @{{ commit.github.username
}}{%- endif %}\
+ {% endfor %}
+{% endfor %}
+## New Contributors
+{% for contributor in github.contributors | filter(attribute="is_first_time",
value=true) %}
+ * @{{ contributor.username }} made their first contribution in #{{
contributor.pr_number }}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+ # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff"; }, #
replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+ # Replace issue numbers
+ #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace =
"([#${2}](<REPO>/issues/${2}))"},
+ # Check spelling of the commit with https://github.com/crate-ci/typos
+ # If the spelling is incorrect, it will be automatically fixed.
+ #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+ { message = "^feat", group = "<!-- 00 -->๐ Features" },
+ { message = "^fix", group = "<!-- 01 -->๐ Bug Fixes" },
+ { message = "^doc", group = "<!-- 03 -->๐ Documentation" },
+ { message = "^perf", group = "<!-- 04 -->โก Performance" },
+ { message = "^refactor", group = "<!-- 02 -->๐ Refactor" },
+ { message = "^style", group = "<!-- 05 -->๐จ Styling" },
+ { message = "^test", group = "<!-- 07 -->๐งช Testing" },
+ { message = "^chore\\(release\\): prepare for", skip = true },
+ { message = "^chore\\(deps.*\\)", skip = true },
+ { message = "^chore\\(pr\\)", skip = true },
+ { message = "^chore\\(pull\\)", skip = true },
+ { message = "^build: bump version", skip = true },
+ { message = "^build", group = "<!-- 06 -->๐ ๏ธ Build" },
+ { message = "^chore|^ci", group = "<!-- 08 -->โ๏ธ Miscellaneous Tasks" },
+ { body = ".*security", group = "<!-- 09 -->๐ก๏ธ Security" },
+ { message = "^revert", group = "<!-- 10 -->โ๏ธ Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping
commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "^release-[0-9]+\\.[0-9]+\\.[0-9]+$"
+# regex for skipping tags
+# skip_tags = ""
+# regex for ignoring tags
+# ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42
+
+[remote.github]
+owner = "apache"
+repo = "hudi-rs"
