[JacobCoffee]

Summary

Add an official GitHub Action to make bunenv easy to use in CI/CD workflows, similar to actions/setup-python or actions/setup-node.

Motivation

Currently, users need to manually install bunenv and create environments in their workflows:

- run: pip install bunenv
- run: bunenv .bunenv --bun=latest
- run: source .bunenv/bin/activate

This PR adds a reusable action that simplifies this to:

- uses: JacobCoffee/bunenv@v1
  with:
    bun-version: 'latest'

Changes

New Files

action.yml - Composite GitHub Action

• Sets up Python
• Installs bunenv
• Creates Bun environment
• Activates environment (adds to PATH)
• Verifies installation
• Automatic caching support

ACTION.md - Complete Documentation

• Quick start examples
• Matrix testing
• Cross-platform usage
• Polyglot projects
• Troubleshooting
• Comparison with other solutions

Updated Files

README.md

• Added GitHub Actions section under CI/CD Integration
• Shows both action usage (recommended) and manual setup

.github/workflows/ci.yml

• Added action-test job to validate the action
• Tests on Ubuntu, macOS, Windows
• Tests with multiple Bun versions (latest, 1.3.3)

Features

✅ Isolated Environments - Each workflow gets its own Bun environment
✅ Automatic Caching - Caches Bun installations for faster runs
✅ Version Pinning - Lock to specific Bun versions
✅ Cross-Platform - Ubuntu, macOS, Windows support
✅ Variant Support - baseline, musl, profile variants
✅ Zero Config - Sensible defaults, works out of the box

Usage Examples

Basic

steps:
  - uses: actions/checkout@v4
  - uses: JacobCoffee/bunenv@v1
  - run: bun install && bun test

Matrix Testing

strategy:
  matrix:
    bun-version: ['latest', '1.3.3', '1.3.0']
steps:
  - uses: JacobCoffee/bunenv@v1
    with:
      bun-version: ${{ matrix.bun-version }}

Polyglot Project

- uses: actions/setup-python@v5
  with:
    python-version: '3.12'
    
- uses: JacobCoffee/bunenv@v1
  with:
    bun-version: 'latest'

- run: pip install -r requirements.txt
- run: bun install
- run: pytest && bun test

Inputs

Input	Description	Default
bun-version	Bun version to install	latest
variant	Bun variant (baseline, musl, etc)	"" (auto)
github-token	GitHub token for API requests	${{ github.token }}
cache	Enable caching	true
python-version	Python version for bunenv	3.12

Outputs

Output	Description
bun-version	Actual Bun version installed
bunenv-path	Path to bunenv environment

Testing

The PR includes an action-test job that:

• Tests on Ubuntu, macOS, Windows
• Tests with multiple Bun versions
• Verifies Bun installation and functionality
• Validates caching works correctly

Benefits Over Manual Setup

Before:

- name: Setup Bun
  run: |
    pip install bunenv
    bunenv .bunenv --bun=1.3.3 --github-token=${{ secrets.GITHUB_TOKEN }}
    source .bunenv/bin/activate  # Doesn't work on Windows!

After:

- uses: JacobCoffee/bunenv@v1
  with:
    bun-version: '1.3.3'

Future Enhancements

Potential future improvements (not in this PR):

• Support for bunfile.lock version detection
• Automatic variant detection for container environments
• Custom installation directory
• Pre/post hooks for custom setup

Documentation

Complete documentation is in ACTION.md including:

• Quick start guide
• Common use cases
• Advanced examples
• Troubleshooting
• Comparison with alternatives

See ACTION.md for full details.

---

🤖 Generated with Claude Code