DanielCarter-stack commented on PR #10466:
URL: https://github.com/apache/seatunnel/pull/10466#issuecomment-3866405455
<!-- code-pr-reviewer -->
<!-- cpr:pr_reply_v2_parts {"group": "apache/seatunnel#10466", "part": 1,
"total": 1} -->
### Issue 1: Version number hardcoded instead of using a variable
**Location**: `pom.xml:29`
**Current code**:
```xml
<version>3.0.0-SNAPSHOT</version>
```
**Previous code**:
```xml
<version>${revision}</version>
```
**Problem description**:
The release preparation process replaces the `${revision}` variable with a
hardcoded `3.0.0-SNAPSHOT`. While this is **standard behavior of
maven-release-plugin**, it has several potential issues:
1. **Reduced maintainability**: If the version number needs to be modified
uniformly, all 300+ POM files need to be modified instead of just one variable
2. **Inconsistent with project history**: The project previously used the
`${revision}` variable to manage version numbers
**Potential risks**:
- **Low risk**: This is standard behavior of Maven Release Plugin, not an
error
- May need to manually change the version number back to the `${revision}`
variable in the next version
**Impact scope**:
- **Direct impact**: Version number management for all submodules
- **Affected area**: The entire project
**Severity**: **MINOR**
**Improvement suggestions**:
```xml
<!-- 在 pom.xml 的 properties 部分定义 -->
<properties>
<revision>3.0.0-SNAPSHOT</revision>
...
</properties>
<!-- 在 version 部分使用变量 -->
<version>${revision}</version>
```
**Rationale**: Maintain consistency with the project's previous version
management strategy to facilitate unified version number management.
---
### Issue 2: Timing of .gitignore modifications
**Location**: `.gitignore:52`
**Change content**:
```diff
-seatunnel-examples
```
**Problem description**:
Removing the `seatunnel-examples` entry from `.gitignore` in the release
preparation PR. This change is reasonable, but needs confirmation:
1. Should this directory now be included in version control?
2. Or should this change have been completed in a previous development PR?
**Potential risks**:
- If the `seatunnel-examples` directory contains example code, including it
in version control will increase repository size
- If this is an intentional change, the reason should be explained in the
commit message
**Impact scope**:
- **Direct impact**: Version control scope of the Git repository
- **Affected area**: Project overall
**Severity**: **MINOR**
**Improvement suggestions**:
✅ **Current approach is acceptable**, but it is recommended to explain in
the commit message or PR description:
> "Remove the gitignore entry for seatunnel-examples because this directory
should now be included in version control"
---
### Issue 3: Chinese Changelog incomplete
**Location**: `docs/zh/connectors/changelog/`
**Problem description**:
Comparison reveals a large number of new Chinese changelog files (such as
`connector-aerospike.md`, `connector-amazondynamodb.md`,
`connector-amazonsqs.md`, etc.), but verification is needed for:
1. The translation quality of these files
2. Whether all English changelogs have corresponding Chinese versions
**Check results**:
```
英文 changelog 文件: ~60 个
中文 changelog 文件: ~80 个（包含新增）
```
**Potential risks**:
- Translation accuracy: Machine translation or human translation may contain
errors
- Synchronization: Both Chinese and English versions need to be maintained
simultaneously during future updates
**Impact scope**:
- **Direct impact**: Chinese users
- **Affected area**: Connector documentation
**Severity**: **MINOR**
**Improvement suggestions**:
1. ✅ **Current approach is excellent**, providing complete Chinese
documentation
2. Suggest adding translation quality checks in CI/CD
3. Suggest explicitly requiring simultaneous updates to both Chinese and
English changelogs in the documentation contribution guidelines
---
### Issue 4: Release Note format inconsistency
**Location**: `release-note.md`
**Problem description**:
Some format inconsistency issues were found in `release-note.md`:
1. **Inconsistent heading format**:
- Some use `[Feature][Connector-V2]`
- Some use `[Feature] [Connector-V2]` (note the space)
- Some use `[Improve]` vs `[Improvement]`
2. **Examples**:
```markdown
- [Feature][Connector-V2] Support sync_mode=update for
FtpFile/SftpFile/LocalFile source (binary) (#10437)
- [Feature] [Connector-V2] Postgresql support read TIMESTAMP_TZ (#10048) #
注意双空格
- [Improve][Zeta] Improve job metrics handling with partitioning support
(#9833)
- [Improvement][Connector] Upgrade Kafka client version from 3.2.0 to 3.4.0
(#9941) # Improvement 而非 Improve
```
**Potential risks**:
- Affects the professionalism of the release notes
- May cause parsing scripts (if any) to fail
**Impact scope**:
- **Direct impact**: Readability and consistency of release notes
- **Affected area**: User reading experience
**Severity**: **MINOR**
**Improvement suggestions**:
1. Use `[Feature]` consistently instead of `[Feat]`
2. Use `[Improve]` consistently instead of `[Improvement]`
3. Remove extra spaces
4. Suggest using tools (such as `spotless` or custom scripts) to
automatically check format
---
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
