发布 v0.0.6 版本 by Certseeds · Pull Request #10 · Certseeds/algorithm-template-java

Certseeds · 2025-09-20T04:51:37Z

Description

主要目标：

命名与依赖对齐：artifactId 与仓库名统一；补充缺失依赖，修复测试编译问题
文档强化：澄清 Java 版本策略、增加“快速上手”；统一用语与命令，修正示例笔误
CI 提效：GitHub Actions 取消手工 zip，避免二次压缩，仅由 upload-artifact 压缩一次

变更摘要：

POM 与依赖
- 根 pom：补充 lombok 依赖（scope=provided），解决测试中 @Slf4j 的编译问题
- 保持编译目标为 Java 11（与 OJ 环境一致），同时 README 推荐本地使用 JDK 21
文档（README）
- 新增“Java 版本策略（重要）”：本地 JDK21 开发/测试，Maven --release 11 产物兼容 OJ
- 新增“快速上手（5 分钟）”步骤与 PowerShell 命令
- 单模块测试命令更优雅：mvn -q -f lab_welcome/lab_welcome_a/pom.xml test（替代 -pl ... -am）
- 纠正文案与示例：将“c++ 重定向”改为“Java 标准 I/O 重定向”；cal_warpper 更正为 cal；去除无用 HTML 换行；统一 OJ/Java 大小写
- 强调 OJ 单文件提交：快读类需嵌入 Main.java
CI（.github/workflows/pull_request.yml）
- 移除手工 zip 步骤，改为直接用 actions/upload-artifact@v4 上传目录并排除 .git，避免二次压缩
- 保持跨平台测试矩阵（ubuntu/windows）、JDK 21 测试环境

请参考：该 PR 不引入破坏性变更，主要集中在文档与 CI/构建体验优化。

Fixes # (issue)

N/A（无关联的已登记 issue，如需要可在合并前补充）

Type of change

Bug fix (non-breaking change which fixes an issue) // 修复测试因缺失 lombok 依赖导致的编译问题
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update // 已更新并强化 README

How Has This Been Tested?

GitHub Actions：
- ubuntu-latest 与 windows-latest 双平台矩阵，JDK 21 环境，执行 mvn clean compile test 验证构建与测试
- 构建产物上传：确认产物由 upload-artifact 直接压缩，且不包含 .git，无二次压缩
本地验证（Windows PowerShell）：
- mvn -q test 运行根项目测试
- mvn -q -f lab_welcome/lab_welcome_a/pom.xml test 单模块测试命令可用
文档校对：
- README 链接/路径与仓库结构一致；命令在 PowerShell 下可执行
Test A：GitHub Actions 矩阵构建与测试通过（CI）
Test B：单模块测试命令（-f 指定 pom）可执行并通过

Test Configuration:

JDK (local): 21 (Temurin)
Target release: 11（Maven --release 11）
OS: Windows 11 / Ubuntu (CI)
Toolchain: Maven 3.9.x
SDK: N/A
Firmware/Hardware: N/A

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas（README/CI 注释已补充）
I have made corresponding changes to the documentation（README 已更新）
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works（不涉及新增功能）
New and existing unit tests pass locally/CI with my changes
Any dependent changes have been merged and published in downstream modules（无跨仓依赖，N/A）

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

…hm-template-java Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

Copilot

Pull Request Overview

This PR renames the project from CS203_DSAA_template_java to algorithm-template and upgrades the project to version 0.0.6. The changes focus on improving project naming consistency, dependency management, documentation clarity, and CI optimization.

Updated project naming to align artifactId with repository name for better consistency
Enhanced documentation with Java version strategy clarification and quick start guide
Optimized CI workflow by removing manual zip operations and using direct artifact upload

Reviewed Changes

Copilot reviewed 102 out of 108 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
pom.xml	Updated artifactId, version, dependencies, and Maven configuration
README.md	Comprehensive documentation updates with Java version strategy and quick start guide
Multiple pom.xml files	Updated groupId and artifactId references throughout project modules
.github/workflows/*.yml	Updated CI workflows with new repository references and simplified artifact handling
Various Java files	Added SPDX copyright headers and updated license information
Legacy files	Removed Maven wrapper, Node.js config, and Husky pre-commit hooks

Files not reviewed (6)

.idea/.gitignore: Language not supported
.idea/codeStyles/.gitignore: Language not supported
.idea/codeStyles/Project.xml: Language not supported
.idea/codeStyles/codeStyleConfig.xml: Language not supported
.idea/vcs.xml: Language not supported
pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-20T04:52:24Z

pom.xml

+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.42</version>
+            <scope>test</scope>


Lombok dependency should have <scope>provided</scope> instead of <scope>test</scope>. Lombok is a compile-time annotation processor that should be available during compilation but not included in the runtime classpath.

Suggested change

<scope>test</scope>

<scope>provided</scope>

Copilot · 2025-09-20T04:52:25Z

README.md


-1. A+B: lab_00_A ,测试样例
+# 仅运行某一题(例如 lab_welcome_a)的测试
+mvn -q -pl lab_welcome/lab_welcome_a -am test


The command uses -pl and -am flags but the text above mentions using -f for single module testing. This is inconsistent with the stated preference for the -f approach mentioned in line 64's comment about 'more elegant' single module testing.

Suggested change

mvn -q -pl lab_welcome/lab_welcome_a -am test

mvn -q -f lab_welcome/lab_welcome_a/pom.xml test

Copilot · 2025-09-20T04:52:25Z

README.md

-  try (Redirect redirect = Redirect.from(DATA_PATH,"01.data.in", "01.test.out");) {// 设定目录 DATA_PATH在文件里有定义
-      Main.output(Main.cal_warpper(Main.read())); // 执行
+  try (Redirect redirect = Redirect.from(DATA_PATH, "01.data.in", "01.test.out");) {// 设定目录 DATA_PATH在文件里有定义
+      Main.output(Main.cal(Main.read())); // 执行


[nitpick] The method name cal should be calculate or calc for better readability and consistency with standard naming conventions.

Suggested change

Main.output(Main.cal(Main.read())); // 执行

Main.output(Main.calculate(Main.read())); // 执行

Copilot · 2025-09-20T04:52:25Z

build_tools/resources/template/java_template.java


        private Reader() {
            br = new BufferedReader(new InputStreamReader(System.in));
+            st = new StringTokenizer("");


Initializing StringTokenizer with an empty string is unnecessary. Consider initializing it as null and checking for null in the hasNext() method, or initialize it lazily when needed.

Certseeds added 14 commits April 27, 2023 13:09

build: bump version to 0.0.6-SNAPSHOT

e6d2029

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

feat: import hasNext() in quick-Reader

30a2774

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

feat: update pnpm-lock.yaml to v6.0

685e773

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

feat: 移除无用组件

6c372f8

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

build: 升级依赖, 适配 JDK21

329bf18

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

fix: 移除 ubuntu-22.04 测试环境

72f6189

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

docs: 更新 README

7b0588d

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

docs: 更新文档

fdbc917

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

feat: 更新依赖, 现在 slf4j, lombok 也是 test 依赖了

8f7b601

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

docs: 更新版权信息

008481d

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

feat: 更新 pom.xml

7c4e6dc

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

refactor: 重构引用路径, 将 artifactId 切换到 algorithm-template, 仓库名切换到 algorit…

2cec79d

…hm-template-java Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

fix: 去除多余的上传步骤

ec2e6b6

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

feat: 进一步精简上传步骤

acb5459

Signed-off-by: Certseeds <51754303+Certseeds@users.noreply.github.com>

Certseeds assigned Certseeds and Copilot Sep 20, 2025

Certseeds added this to Standard_Template_Construct Sep 20, 2025

Copilot AI review requested due to automatic review settings September 20, 2025 04:51

Certseeds added the enhancement New feature or request label Sep 20, 2025

Copilot AI reviewed Sep 20, 2025

View reviewed changes

Certseeds merged commit 4c53d60 into release Sep 20, 2025
5 of 9 checks passed

github-project-automation bot moved this to Done in Standard_Template_Construct Sep 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

发布 v0.0.6 版本#10

发布 v0.0.6 版本#10
Certseeds merged 14 commits intoreleasefrom
develop

Certseeds commented Sep 20, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	mvn -q -pl lab_welcome/lab_welcome_a -am test
	mvn -q -f lab_welcome/lab_welcome_a/pom.xml test

	Main.output(Main.cal(Main.read())); // 执行
	Main.output(Main.calculate(Main.read())); // 执行

Conversation

Certseeds commented Sep 20, 2025

Description

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants