Skip to content

stop tracking wifi_config.h and update CI workflow#62

Closed
gsh1209 wants to merge 1 commit into
chenxuuu:masterfrom
gsh1209:untrack-config-file
Closed

stop tracking wifi_config.h and update CI workflow#62
gsh1209 wants to merge 1 commit into
chenxuuu:masterfrom
gsh1209:untrack-config-file

Conversation

@gsh1209

@gsh1209 gsh1209 commented Apr 18, 2026

Copy link
Copy Markdown
Contributor

问题:
Commit f4224f8 中用 .gitignore 排除了 wifi_config.h,但该规则只对未追踪(untracked)的文件生效,一旦文件曾经被 git add 过,Git 就会持续追踪它的变更,忽略规则无效。

修改:

  • 停止追踪文件 wifi_config.h
  • 引入配置模板 wifi_config.h.example,保留原配置文件需要用户填写的信息;
  • 增加 README 编译说明,增加 cp wifi_config.h.example wifi_config.h 的 CI 流程。

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request introduces a template for WiFi configuration, updates the .gitignore to exclude local configuration files, and adds compilation instructions to the README. Feedback indicates that the CI workflow may need updates to handle the new file structure to prevent build failures and suggests untracking the existing configuration file from the Git index to ensure the ignore rules are effective.

Comment thread README.md

需要在`Arduino IDE`中安装ESP32开发板支持,参考[官方文档](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html),版型选`MakerGO ESP32 C3 SuperMini`。

## 软件编译

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

PR 标题和描述中提到了更新 CI 流程,但在当前的提交中没有看到任何 CI 配置文件(例如 .github/workflows/ 下的 YAML 文件)的修改。如果 CI 流程没有同步更新以执行 cp 命令生成 wifi_config.h,由于该文件已被忽略且建议从仓库移除,CI 上的自动化编译将会失败。

Comment thread README.md
克隆仓库后,复制 WiFi 信息配置文件模板,并填入 WiFi SSID 和 WiFi 密码:

```bash
cp code/wifi_config.h.example code/wifi_config.h

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

虽然 README 中增加了编译说明,但根据 PR 描述,本意是“停止追踪” wifi_config.h。目前该文件似乎仍然存在于仓库的索引中(在文件列表中可见)。为了彻底停止追踪并使 .gitignore 生效,你需要执行 git rm --cached code/wifi_config.h 并提交该变更。否则,该文件及其后续变更仍会被 Git 记录。

Signed-off-by: gsh1209 <gsh1209@outlook.com>
@gsh1209 gsh1209 force-pushed the untrack-config-file branch from 82b583d to 3320344 Compare April 18, 2026 07:12
@gsh1209

gsh1209 commented Apr 18, 2026

Copy link
Copy Markdown
Contributor Author

awesome bot😂

@chenxuuu

chenxuuu commented Apr 19, 2026 via email

Copy link
Copy Markdown
Owner

@gsh1209

gsh1209 commented Apr 19, 2026

Copy link
Copy Markdown
Contributor Author

👌👌

@gsh1209 gsh1209 closed this Apr 19, 2026
@chenxuuu

Copy link
Copy Markdown
Owner

如果可以做到自动检测是否包含这个头文件,做到开箱即用的话,其实也可以

@gsh1209

gsh1209 commented Apr 20, 2026 via email

Copy link
Copy Markdown
Contributor Author

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.

2 participants