Skip to content

Setup repository for npm publishing#5

Merged
MichaelFisher1997 merged 5 commits intomainfrom
setup-for-publishing-v2
Feb 7, 2026
Merged

Setup repository for npm publishing#5
MichaelFisher1997 merged 5 commits intomainfrom
setup-for-publishing-v2

Conversation

@MichaelFisher1997
Copy link
Collaborator

This PR prepares the repository for publishing to npm as @openstaticfish/actionflow.

Changes

New Files

  • LICENSE - MIT License for OpenStaticFish
  • .npmignore - Excludes source files and dev dependencies from npm package

Updated Files

  • package.json - Renamed to @openstaticfish/actionflow v0.1.0 with:

    • Proper npm metadata (description, keywords, author)
    • Binary aliases: actionflow and af
    • Build scripts including prepublishOnly
    • Files whitelist for publishing
    • Bun engine requirement
  • tsconfig.json - Added TypeScript declaration generation support

  • README.md - Updated with new package name and install instructions

  • AGENTS.md - Updated header reference

  • src/tui/components/Header.tsx - Updated UI title to "ACTIONFLOW"

Build Verification

  • ✅ Dependencies installed (including missing react-devtools-core)
  • ✅ Build successful (2.1MB bundle in dist/)
  • ✅ Type declarations generated
  • npm pack --dry-run shows 50 files ready for publish

Next Steps After Merge

  1. Login to npm: npm login
  2. Publish: `npm publish --access public"

Testing

This PR should trigger the OpenCode AI PR review workflow to verify the changes.

- Add MIT LICENSE for OpenStaticFish
- Add .npmignore to exclude dev files
- Rename package to @openstaticfish/actionflow v0.1.0
- Add npm publishing metadata (bin, files, exports, engines)
- Update tsconfig.json for declaration generation
- Update README.md with new package name and install instructions
- Update Header.tsx UI title to ACTIONFLOW
- Update AGENTS.md header reference

Prepares repository for publishing to npm registry
Fixes the heredoc syntax issue that was causing workflow validation failures.
Replaced problematic heredoc with jq-based JSON construction for proper
escaping of special characters in PR diff and comments.

Changes:
- workflows/opencode/pr/opencode-pr.yml: Use jq to build API payload
- workflows/opencode/pr/opencode-pr-nix.yml: Same fix for Nix variant
- .github/workflows/opencode-pr.yml: Apply fix to installed workflow

This resolves the "Invalid workflow file" error that prevented the
OpenCode AI PR review from running.
The previous fix had issues with backtick escaping in jq strings.
Replaced inline jq string construction with printf for building the
prompt, then pass the complete prompt to jq using --arg.

This avoids escape character issues with backticks and newlines
in the JSON construction.
Replaced broken heredoc/curl approach with anomalyco/opencode/github@latest
GitHub Action, matching the working implementation from ZigCraft.

Templates updated:
- workflows/opencode/pr/opencode-pr.yml
- workflows/opencode/opencode/opencode.yml
- workflows/opencode/triage/opencode-triage.yml

This fixes the YAML syntax errors and API integration issues.
@opencode-agent
Copy link

opencode-agent bot commented Feb 7, 2026


📋 Summary

No linked issues found in the PR description.

This PR prepares the repository for npm publishing as @openstaticfish/actionflow v0.1.0. It adds proper package metadata, an MIT license, npmignore configuration, TypeScript declaration generation, and binary aliases (actionflow and af). The documentation is updated to reflect the new package name and installation instructions. The changes are well-structured and follow npm publishing best practices.

🔴 Critical Issues (Must Fix - Blocks Merge)

None identified.

⚠️ High Priority Issues (Should Fix)

None identified.

💡 Medium Priority Issues (Nice to Fix)

None identified.

ℹ️ Low Priority Suggestions (Optional)

[LOW] AGENTS.md:53-54 - Documentation inconsistency with tsconfig
Confidence: Medium
Description: The AGENTS.md file documents noEmit: true as a TypeScript configuration requirement, but this PR changes it to noEmit: false to enable declaration generation. This creates a documentation inconsistency.
Impact: Developers following AGENTS.md may be confused about the configuration.
Suggested Fix: Update AGENTS.md line 53 to reflect that noEmit is now false for declaration generation, and add a note that it's set to false specifically for the build:types script.

📊 SOLID Principles Score

Principle Score Notes
Single Responsibility 9 Each file has a clear, focused purpose
Open/Closed 8 Configuration changes are additive; existing functionality unchanged
Liskov Substitution 10 No inheritance hierarchies modified
Interface Segregation 10 Clean separation between package config and code
Dependency Inversion 10 No coupling issues introduced
Average 9.4

🎯 Final Assessment

Overall Confidence Score: 95%

Confidence Breakdown:

  • Code Quality: 95% (clean, well-organized configuration changes)
  • Completeness: 95% (all necessary npm publishing artifacts included)
  • Risk Level: 5% (low risk - configuration-only changes)
  • Test Coverage: N/A% (no test changes required for configuration PR)

Merge Readiness:

  • All critical issues resolved
  • SOLID average score >= 6.0
  • Overall confidence >= 60%
  • No security concerns
  • Tests present and passing (if applicable)

Verdict:

MERGE

This is a clean, well-prepared npm publishing setup PR with no blocking issues.

New%20session%20-%202026-02-07T20%3A31%3A19.510Z
opencode session  |  github run

@MichaelFisher1997 MichaelFisher1997 merged commit 7352c1d into main Feb 7, 2026
1 check passed
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