bumpx-action

bumpx Installer

A GitHub Action to install system dependencies using bumpx.

Usage

This action allows you to easily install dependencies with bumpx in your GitHub Actions workflows.

- name: Install Dependencies with bumpx
  uses: stacksjs/bumpx-installer@v1
  # Automatically detects and installs project dependencies
  # Optional parameters:
  # with:
  #   packages: node python go # override auto-detection
  #   config-path: bumpx.config.ts

Inputs

Name	Description	Required	Default
packages	Space-separated list of packages to install (overrides auto-detection)	No	(empty) - auto-detects from project files
config-path	Path to bumpx config file	No	bumpx.config.ts

Features

• 🚀 Cross-platform support: Works on Linux, macOS, and Windows runners
• 🔍 Smart dependency detection: Automatically detects project dependencies from package.json, requirements.txt, go.mod, and more
• 🔄 Config file support: Can extract package list from your bumpx config file
• 🌐 Context-aware: Provides full GitHub context to commands
• 🔧 Bun-powered: Uses Bun for faster installation

Examples

Basic Usage (Auto-detection)

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Dependencies
        uses: stacksjs/bumpx-installer@v1
        # Automatically detects Node.js from package.json
        # and installs node + any other detected dependencies

Using with Config File

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Dependencies from Config
        uses: stacksjs/bumpx-installer@v1
        # Will automatically detect packages from bumpx.config.ts

Multi-platform Workflow

name: Multi-platform CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Dependencies
        uses: stacksjs/bumpx-installer@v1
        # Auto-detects dependencies across all platforms

Manual Package Override

name: Manual Override

on:
  push:
    branches: [main]

jobs:
  setup:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Specific Dependencies
        uses: stacksjs/bumpx-installer@v1
        with:
          packages: node python go rust
          # Override auto-detection with specific packages

      - name: Run Tests
        run: npm test

Custom Config Path

name: Custom Config

on:
  push:
    branches: [main]

jobs:
  setup:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Dependencies from Custom Config
        uses: stacksjs/bumpx-installer@v1
        with:
          config-path: .github/bumpx.config.ts

      - name: Run Tests
        run: npm test

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

"Software that is free, but hopes for a postcard." We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

• JetBrains
• The Solana Foundation

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙