Skip to content

Standardize: CI/CD, Build Artifacts, and Repo Settings #235

@kochizufan

Description

@kochizufan

Based on the standardization policy defined in MaplatHarmony#3, please verify and apply the following changes:

1. Repository & Branching

  • Default Branch: Ensure it is set to master.

2. Build & Output (dist)

  • Remove CommonJS: Ensure package.json has "type": "module" and main points to an ESM entry (e.g., index.js). Remove any .cjs outputs/support.
  • Types: Ensure d.ts files are generated and included in the package.
  • Clean Output: dist/ should NOT contain dev-server artifacts (e.g., index.html, hashed index.es-*.js). It should only contain the clean library build (and d.ts).
  • Gitignore: dist should typically be valid for npm publish but ignored in git. Verify artifacts are correct.

3. Dev Server & GH Pages

  • Dev URL: pnpm dev should serve index.html at the root (http://localhost:5173/).
  • GH Pages: The content served by pnpm dev should match what is published to gh-pages.
  • Deployment Rule: Deploy to gh-pages ONLY on pushes to master.

4. CI/CD (GitHub Actions)

  • Missing CI: If .github/workflows is missing, add it using the standard MaplatHarmony pattern.
  • Triggers: Run on ALL commits (pnpm test, pnpm lint, pnpm typecheck, pnpm build).
  • Nodes: Use Node 20 and 22 (Drop 18).
  • Linting: Enforce linting in CI (do not use local husky/lint-staged hooks).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions