Skip to content

Conversation

@dcramer
Copy link
Member

@dcramer dcramer commented Jul 16, 2025

Summary

  • Remove dist/ from .gitignore as it's required for GitHub Actions
  • Commit all compiled artifacts from dist/ directory
  • Add explanatory documentation about why dist/ must be committed

Background

GitHub Actions run directly from the repository without a build step, so compiled artifacts must be committed. This differs from typical JavaScript/TypeScript projects where build outputs are ignored.

Test plan

  • Verified action.yml points to dist/index.js
  • Rebuilt dist/ files to ensure they're current
  • Added clear documentation explaining the requirement
  • All 45 compiled files now tracked in source control

dcramer added 2 commits July 16, 2025 17:32
- Remove dist/ from .gitignore as it's required for GitHub Actions
- Add explanatory comment about why dist/ must be committed
- Rebuild dist/ files to ensure they're up-to-date

GitHub Actions require compiled artifacts to be committed since
they run directly from the repository without a build step.
- Add explicit section explaining why dist/ must be committed
- Clarify that GitHub Actions differ from typical JS/TS projects
- Reference action.yml main entry point and check-dist.yml workflow
@dcramer dcramer merged commit b9f29b8 into main Jul 16, 2025
6 of 8 checks 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.

2 participants