Skip to content

chore: optimize project metadata and CI/CD#8

Open
AIPMAndy wants to merge 1 commit into
mainfrom
optimize-project-metadata
Open

chore: optimize project metadata and CI/CD#8
AIPMAndy wants to merge 1 commit into
mainfrom
optimize-project-metadata

Conversation

@AIPMAndy

Copy link
Copy Markdown
Owner

概述

本 PR 优化了项目的元数据配置和 CI/CD 流程,修复了命名不一致问题,并添加了完善的项目文档。

变更内容

1. 修复命名不一致

  • package.json:

    • 项目名称: articlelayoutmdskill-web
    • 描述更新为与项目定位一致
    • 仓库地址修正: ArticleLayout.gitMDskill-Web.git
    • 关键词优化,添加 mdskill
  • CLI.md:

    • 标题: PageSkill CLIMDskill CLI
    • 所有文档中的 PageSkill 引用统一改为 MDskill
    • 配置文件示例: .pageskillrc.mdskillrc
    • GitHub 链接更新

2. 添加 GitHub Actions CI/CD

CI Workflow (.github/workflows/ci.yml)

  • 支持 Node.js 18.x 和 20.x 多版本测试
  • 自动运行类型检查 (npm run lint)
  • 自动构建项目 (npm run build)
  • 上传构建产物供后续使用
  • 触发条件: push 和 PR 到 main/develop 分支

Deploy Workflow (.github/workflows/deploy.yml)

  • 自动部署到 GitHub Pages
  • 仅在 main 分支推送时触发
  • 支持手动触发 (workflow_dispatch)
  • 使用最新的 GitHub Pages Actions v4

3. 添加项目文档

CONTRIBUTING.md

  • 开发环境设置指南
  • 提交规范 (Conventional Commits)
  • 工作流程说明
  • 代码规范要求
  • PR 检查清单
  • Bug 报告和功能建议指南
  • 新主题贡献指南

CHANGELOG.md

  • 遵循 Keep a Changelog 格式
  • 记录 1.0.0 版本的初始功能
  • 记录本次优化的变更内容
  • 为未来版本迭代建立追踪机制

4. 优化 README

  • 添加 CI 状态徽章
  • 添加部署状态徽章
  • 添加许可证徽章
  • 添加 GitHub Stars 徽章

测试验证

  • ✅ 本地构建成功: npm run build
  • ✅ 类型检查通过: npm run lint
  • ✅ Git 提交信息符合规范
  • ✅ 所有文件路径正确

影响范围

  • 破坏性变更: 无
  • 向后兼容: 是
  • 依赖变更: 无

后续工作

合并后建议:

  1. 在仓库设置中启用 GitHub Pages (Settings → Pages → Source: GitHub Actions)
  2. 保护 main 分支,要求 CI 通过才能合并
  3. 根据 CONTRIBUTING.md 建立协作流程

检查清单

  • 修复 package.json 命名不一致
  • 修复 CLI.md 中的 PageSkill 引用
  • 添加 CI workflow
  • 添加 Deploy workflow
  • 添加 CONTRIBUTING.md
  • 添加 CHANGELOG.md
  • 添加 README 徽章
  • 本地构建测试通过
  • 提交信息符合规范

- Fix naming inconsistencies: articlelayout → mdskill-web in package.json
- Fix PageSkill → MDskill in CLI.md
- Add GitHub Actions CI workflow for build and type checking
- Add GitHub Actions deployment workflow for GitHub Pages
- Add CONTRIBUTING.md with contribution guidelines
- Add CHANGELOG.md for version tracking
- Add badges to README (CI, Deploy, License, Stars)
@netlify

netlify Bot commented Jun 17, 2026

Copy link
Copy Markdown

Deploy Preview for mdskill ready!

Name Link
🔨 Latest commit 8f7ef74
🔍 Latest deploy log https://app.netlify.com/projects/mdskill/deploys/6a32bb9516afa50008b82be6
😎 Deploy Preview https://deploy-preview-8--mdskill.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8f7ef74940

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +32 to +33
- name: Build
run: npm run build

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Set the Pages base path before building

When this workflow deploys AIPMAndy/MDskill-Web as a GitHub Pages project site, the app is served under /MDskill-Web/, but this build still uses the repo's existing Vite config with no base override. Vite will emit root-relative URLs such as /assets/... and the existing /favicon.svg, so the deployed page requests assets from https://aipmandy.github.io/assets/... instead of the project path and loads as a blank/broken app unless a custom root domain is configured.

Useful? React with 👍 / 👎.

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.

1 participant