Skip to content

Latest commit

 

History

History
146 lines (108 loc) · 2.63 KB

GIT_COMMIT_CHECKLIST.md

File metadata and controls

146 lines (108 loc) · 2.63 KB

Git提交前检查清单

✅ 已完成的清理

删除的文件

  • ✅ test_boto3_env.py
  • ✅ diagnose_aws.py
  • ✅ check_env.py
  • ✅ quick_setup_aws.bat
  • ✅ set_aws_env.ps1

创建的安全文件

  • ✅ .gitignore - 防止敏感信息提交

⚠️ 提交前检查

1. 检查敏感信息

# 检查是否有AWS凭证
git grep -i "AKIA" 
git grep -i "aws_secret"

# 检查config.yaml
git diff config.yaml

2. 确认.gitignore生效

git status

应该看到以下文件被忽略：

  • output/ 目录
  • logs/ 目录
  • config.yaml (包含真实配置)
  • *.log 文件

3. 提交前清理

# 查看将要提交的文件
git status

# 如果config.yaml被追踪，移除它
git rm --cached config.yaml

# 添加文件
git add .

# 提交
git commit -m "feat: 添加定时任务和S3上传功能"

📁 应该提交的文件

核心代码

  • ✅ src/services/scheduler.py
  • ✅ src/services/article_aggregator.py
  • ✅ src/services/wechat_controller.py
  • ✅ src/addons/wechat_article_parser.py
  • ✅ src/models/config.py
  • ✅ src/utils/config_loader.py

启动脚本

  • ✅ scheduled_scraper.py
  • ✅ start_scheduled_scraper.bat
  • ✅ install_scheduler_deps.bat

配置模板

  • ✅ config.yaml.template
  • ✅ requirements.txt

文档

  • ✅ README.md
  • ✅ AWS_SETUP.md

安全文件

  • ✅ .gitignore

❌ 不应该提交的文件

敏感信息

  • ❌ config.yaml (包含真实S3桶名)
  • ❌ .aws/ 目录
  • ❌ 任何包含AWS凭证的文件

输出和日志

  • ❌ output/ 目录
  • ❌ logs/ 目录
  • ❌ *.log 文件

测试文件

  • ❌ test_*.py
  • ❌ diagnose_*.py
  • ❌ check_*.py

🔒 安全建议

  1. 永远不要提交:

    • AWS Access Key
    • AWS Secret Key
    • 真实的S3桶名称
    • 任何密码或令牌

  2. 使用环境变量或配置文件:

    • 敏感信息放在 .gitignore 中的文件
    • 提供 .template 文件作为示例

  3. 定期检查:

    git log -p | grep -i "AKIA"

📝 提交信息模板

feat: 添加定时任务和S3上传功能

- 实现每天晚上12点自动抓取文章
- 添加文章时间过滤（只保留昨天发布的）
- 实现S3自动上传功能
- 文件名包含公众号标识，按日期覆盖
- 添加随机等待时间（30-60秒）
- 自动关闭浏览器窗口

✅ 最终检查

运行以下命令确认：

# 1. 查看将要提交的文件
git status

# 2. 查看具体改动
git diff --cached

# 3. 确认没有敏感信息
git diff --cached | grep -i "AKIA"
git diff --cached | grep -i "secret"

# 4. 如果一切正常，提交
git commit -m "your message"