Package Exports
- buddy-bot
Readme

πΆ Buddy Bot
Automated dependency updates for the JavaScript and TypeScript ecosystem.
A modern, fast alternative to Dependabot and Renovate built for the JavaScript and TypeScript ecosystem. Buddy automatically scans your projects for outdated dependencies and creates well-formatted pull requests with detailed changelogs and metadata.

Features
- π Lightning Fast: Built with Bun & performance in mind
- π― Smart Updates: Configurable update strategies (major, minor, patch, all)
- π¦ Multi-Package Manager: Supports Bun, npm, yarn, pnpm, Composer, pkgx & Launchpad dependency files
- β‘ GitHub Actions: Automatically updates workflow dependencies (
actions/checkout@v4, etc.) - π Dependency Dashboard: Single GitHub issue with overview of all dependencies and open PRs
- π Rebase Functionality: Interactive checkbox to update PRs with latest dependency versions
- π Intelligent Scanning: Uses
bun outdatedand GitHub releases for accurate dependency detection - π Flexible Grouping: Group related packages for cleaner PRs
- π¨ Rich PR Format: Three separate tables (npm, Launchpad/pkgx, GitHub Actions) with detailed metadata
- βοΈ Zero Config: Works out of the box with sensible defaults
- π§ Highly Configurable: Customize everything via
buddy-bot.config.ts - π οΈ Simple Setup Experience: Renovate-like interactive setup with validation and smart recommendations
- π Pre-flight Validation: Environment checks, conflict detection, and prerequisite validation
- π Smart Project Analysis: Automatic project type detection with intelligent recommendations
- π Configuration Migration: Seamless import from Renovate and Dependabot configurations
- π Integration Ecosystem: Extensible plugin system with Slack, Discord, and Jira integrations
Quick Start
# Install globally
bun add -g buddy-bot
# Interactive setup (recommended)
buddy-bot setup
# Non-interactive setup for CI/CD
buddy-bot setup --non-interactive
# Non-interactive with specific preset
buddy-bot setup --non-interactive --preset testing --verbose
# Or run directly for scanning only
buddy-bot scanUsage
Interactive Setup
The easiest way to get started is with the interactive setup command:
buddy-bot setupThis comprehensive setup wizard will guide you through configuring automated dependency updates for your project in a Renovate-like experience.
Non-Interactive Setup
For CI/CD pipelines and automated deployments, use the non-interactive mode:
# Basic non-interactive setup (uses defaults)
buddy-bot setup --non-interactive
# Specify preset and token setup
buddy-bot setup --non-interactive --preset testing --token-setup existing-secret --verbose
# Production setup with security focus
buddy-bot setup --non-interactive --preset security --token-setup existing-secretAvailable options:
--non-interactive- Skip all prompts, use defaults--preset <type>- Workflow preset:standard,high-frequency,security,minimal,testing(default:standard)--token-setup <type>- Token mode:default-token,existing-secret,new-pat(default:default-token)
The setup process includes:
π Pre-flight Validation
- Environment checks - Validates git repository, Node.js/Bun installation
- Conflict detection - Scans for existing dependency management tools (Renovate, Dependabot)
- Git configuration - Ensures proper git user setup
- GitHub CLI detection - Suggests helpful tools for authentication
π Smart Project Analysis
- Project type detection - Identifies library, application, monorepo, or unknown projects
- Package manager detection - Detects Bun, npm, yarn, pnpm with lock file validation
- Dependency ecosystem analysis - Finds pkgx, Launchpad dependency files
- GitHub Actions discovery - Scans existing workflows for updates
- Intelligent recommendations - Suggests optimal setup based on project characteristics
π Interactive Progress Tracking
- Visual progress bar - Real-time completion percentage with progress indicators
- Step-by-step guidance - Clear indication of current and completed steps
- Time tracking - Setup duration monitoring
- Recovery capabilities - Resume from failures with detailed error reporting
π Step 1: Configuration Migration & Discovery
- Tool Detection - Automatically detects existing Renovate and Dependabot configurations
- Seamless Migration - Imports settings, schedules, package rules, and ignore patterns
- Compatibility Analysis - Identifies incompatible features and provides alternatives
- Migration Report - Detailed summary of migrated settings and confidence levels
π Step 2: Integration Discovery
- Plugin Discovery - Automatically detects available integrations (Slack, Discord, Jira)
- Environment Detection - Scans for webhook URLs, API tokens, and configuration files
- Plugin Loading - Enables discovered integrations for setup completion notifications
- Custom Plugins - Supports custom plugin definitions in
.buddy/plugins/directory
π Step 3: Repository Detection & Validation
- Automatically detects your GitHub repository from git remote
- API validation - Tests repository access and permissions via GitHub API
- Repository health checks - Validates issues, permissions, and settings
- Private repository support - Enhanced validation for private repositories
π Step 4: Enhanced Token Setup
- Guides you through creating a Personal Access Token (PAT)
- Scope validation - Explains required scopes (
repo,workflow) with examples - Token testing - Validates token permissions before proceeding
- Helps set up repository secrets for enhanced features
π§ Step 5: Repository Settings Validation
- Walks you through GitHub Actions permissions configuration
- Permission verification - Tests workflow permissions in real-time
- Organization settings - Guidance for organization-level permissions
- Ensures proper workflow permissions for PR creation
βοΈ Step 6: Intelligent Workflow Configuration Choose from several carefully crafted presets with smart recommendations:
- Standard Setup (Recommended) - Dashboard updates 3x/week, balanced dependency updates
- High Frequency - Check for updates multiple times per day
- Security Focused - Frequent patch updates with security-first approach
- Minimal Updates - Weekly checks, lower frequency
- Development/Testing - Manual triggers + frequent checks for testing
- Custom Configuration - Advanced schedule builder with cron preview
π Step 7: Enhanced Configuration Generation
- Creates
buddy-bot.config.jsonwith repository-specific settings - Project-aware defaults - Configuration optimized for detected project type
- Ecosystem integration - Includes detected package managers and dependency files
- Includes sensible defaults and customization options
π Step 8: Workflow Generation & Validation
- Generates three core GitHub Actions workflows:
buddy-dashboard.yml- Dependency Dashboard Managementbuddy-check.yml- Auto-rebase PR checkerbuddy-update.yml- Scheduled dependency updates
- YAML validation - Ensures generated workflows are syntactically correct
- Security best practices - Validates token usage and permissions
- Workflow testing - Verifies generated workflows meet requirements
π― Step 9: Comprehensive Validation & Instructions
- Setup verification - Validates all generated files and configurations
- Workflow testing - Tests generated workflow syntax and requirements
- Clear next steps - Git commands and repository setup instructions
- Documentation links - Direct links to GitHub settings pages
- Troubleshooting guide - Common issues and solutions
π Step 10: Integration Notifications
- Plugin Execution - Executes loaded integration hooks for setup completion
- Slack Notifications - Rich setup completion messages with repository details
- Discord Embeds - Colorful setup completion notifications with project information
- Jira Tickets - Automatic task creation for tracking setup completion
- Custom Hooks - Extensible system for organization-specific integrations
Command Line Interface
# Setup commands
buddy setup # Interactive setup (recommended)
buddy setup --non-interactive # Non-interactive with defaults
buddy setup --non-interactive --preset testing --verbose
# Scan for dependency updates
buddy scan
buddy scan --verbose
# Create or update dependency dashboard
buddy dashboard --pin
# Check specific packages
buddy scan --packages "react,typescript,@types/node"
# Check packages with glob patterns
buddy scan --pattern "@types/*"
# Apply different update strategies
buddy scan --strategy minor
buddy scan --strategy patch
# Update dependencies and create PRs
buddy update --dry-run
buddy update
# Check for rebase requests and update PRs
buddy update-check
buddy update-check --dry-run
buddy update-check --verbose
# Get help
buddy helpConfiguration
Create a buddy-bot.config.ts file in your project root:
import type { BuddyBotConfig } from 'buddy-bot'
const config: BuddyBotConfig = {
verbose: false,
// Repository settings for PR creation
repository: {
provider: 'github',
owner: 'your-org',
name: 'your-repo',
token: process.env.GITHUB_TOKEN,
baseBranch: 'main'
},
// Package update configuration
packages: {
strategy: 'all', // 'major' | 'minor' | 'patch' | 'all'
ignore: [
'legacy-package',
'@types/node' // Example ignores
],
groups: [
{
name: 'TypeScript Types',
patterns: ['@types/*'],
strategy: 'minor'
},
{
name: 'ESLint Ecosystem',
patterns: ['eslint*', '@typescript-eslint/*'],
strategy: 'patch'
}
]
},
// Pull request settings
pullRequest: {
titleFormat: 'chore(deps): {title}',
commitMessageFormat: 'chore(deps): {message}',
reviewers: ['maintainer1', 'maintainer2'],
labels: ['dependencies', 'automated'],
autoMerge: {
enabled: true,
strategy: 'squash', // 'merge', 'squash', or 'rebase'
conditions: ['patch-only'] // Only auto-merge patch updates
}
},
// Dependency dashboard settings
dashboard: {
enabled: true,
title: 'Dependency Dashboard',
pin: true,
labels: ['dependencies', 'dashboard'],
assignees: ['maintainer1'],
showOpenPRs: true,
showDetectedDependencies: true
}
}
export default configConfiguration Migration
Buddy Bot can automatically migrate your existing dependency management configurations from Renovate and Dependabot, making the transition seamless.
Supported Migration Sources
- Renovate -
renovate.json,.renovaterc, package.json renovate config - Dependabot -
.github/dependabot.yml,.github/dependabot.yaml
Migration Process
- Automatic Detection - Scans for existing configuration files
- Smart Conversion - Maps settings to Buddy Bot equivalents
- Compatibility Check - Identifies unsupported features
- Migration Report - Provides detailed conversion summary
# Migration happens automatically during setup
buddy-bot setup
# Or use programmatically
import { ConfigurationMigrator } from 'buddy-bot/setup'
const migrator = new ConfigurationMigrator()
const tools = await migrator.detectExistingTools()
const result = await migrator.migrateFromRenovate('renovate.json')Migrated Settings
| Renovate | Dependabot | Buddy Bot | Notes |
|---|---|---|---|
schedule |
schedule.interval |
Workflow presets | Mapped to Standard/High-Frequency/Minimal |
packageRules |
ignore |
Package groups & ignore lists | Preserves grouping logic |
automerge |
N/A | Auto-merge settings | Includes strategy preferences |
assignees/reviewers |
N/A | PR configuration | Maintains team assignments |
Integration Ecosystem
Buddy Bot includes an extensible plugin system that enables integrations with popular collaboration and project management tools.
Built-in Integrations
Slack Integration
# Set environment variable
export SLACK_WEBHOOK_URL="https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK"
# Or create config file
echo "https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK" > .buddy/slack-webhookFeatures:
- Rich setup completion notifications
- Repository and project details
- Error notifications for setup failures
- Configurable channel and username
Discord Integration
# Set environment variable
export DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/YOUR/DISCORD/WEBHOOK"
# Or create config file
echo "https://discord.com/api/webhooks/YOUR/DISCORD/WEBHOOK" > .buddy/discord-webhookFeatures:
- Colorful embed notifications
- Project type and package manager details
- Timestamp tracking
- Setup completion confirmations
Jira Integration
# Set environment variables
export JIRA_API_TOKEN="your-jira-api-token"
export JIRA_BASE_URL="https://your-org.atlassian.net"
export JIRA_PROJECT_KEY="BUDDY" # Optional, defaults to BUDDYFeatures:
- Automatic ticket creation for setup completion
- Repository and project context
- Configurable project keys
- Setup tracking and documentation
Custom Plugins
Create custom integrations by defining plugins in .buddy/plugins/:
// .buddy/plugins/custom-integration.json
{
"name": "custom-integration",
"version": "1.0.0",
"enabled": true,
"triggers": [
{ "event": "setup_complete" },
{ "event": "validation_error" }
],
"hooks": [
{
"name": "custom-notification",
"priority": 10,
"async": true,
"handler": "// Custom JavaScript function"
}
],
"configuration": {
"webhook_url": "https://your-custom-webhook.com/notify",
"api_key": "your-api-key"
}
}Plugin Events
| Event | Description | Context |
|---|---|---|
pre_setup |
Before setup begins | Initial configuration |
post_setup |
After setup completes | Full setup context |
step_complete |
After each setup step | Step-specific progress |
validation_error |
When validation fails | Error details and recovery |
setup_complete |
Final setup completion | Complete project context |
Programmatic Usage
import { Buddy, ConfigManager } from 'buddy-bot'
// Load configuration
const config = await ConfigManager.loadConfig()
// Create Buddy instance
const buddy = new Buddy(config)
// Scan for updates
const scanResult = await buddy.scanForUpdates()
console.log(`Found ${scanResult.updates.length} updates`)
// Check specific packages
const updates = await buddy.checkPackages(['react', 'typescript'])
// Create pull requests
if (scanResult.updates.length > 0) {
await buddy.createPullRequests(scanResult)
}
// Create or update dependency dashboard
const dashboardIssue = await buddy.createOrUpdateDashboard()
console.log(`Dashboard updated: ${dashboardIssue.url}`)Dependency Dashboard
The dependency dashboard provides a centralized view of all your repository's dependencies and open pull requests in a single GitHub issue. Similar to Renovate's dependency dashboard, it gives you complete visibility into your dependency management.
Key Features
- π Single Overview: All dependencies and PRs in one place
- π Interactive Controls: Force retry/rebase PRs by checking boxes
- π Pinnable Issue: Keep dashboard at the top of your issues
- π·οΈ Smart Categorization: Organized by npm, GitHub Actions, and dependency files
- β‘ Auto-Updates: Refreshes when dependencies change
Rebase Functionality
Buddy Bot includes powerful rebase functionality that allows you to update existing pull requests with the latest dependency versions, similar to Renovate's rebase feature.
How It Works
All Buddy Bot pull requests include a rebase checkbox at the bottom:
---
- [ ] <!-- rebase-check -->If you want to update/retry this PR, check this box
---Using the Rebase Feature
- Check the box: In any Buddy Bot PR, check the rebase checkbox
- Automatic detection: The rebase workflow runs every minute to detect checked boxes
- Updates applied: The PR is automatically updated with the latest dependency versions
- Checkbox unchecked: After successful rebase, the checkbox is automatically unchecked
Rebase Command
You can also trigger rebase manually using the CLI:
# Check for PRs with rebase checkbox enabled and update them
buddy-bot update-check
# Dry run to see what would be rebased
buddy-bot update-check --dry-run
# With verbose output
buddy-bot update-check --verboseAutomated Rebase Workflow
Buddy Bot includes a pre-built GitHub Actions workflow (.github/workflows/buddy-check.yml) that:
- π Runs every minute: Automatically checks for rebase requests
- π Scans all PRs: Finds Buddy Bot PRs with checked rebase boxes
- π¦ Updates dependencies: Re-scans for latest versions and updates files
- π Updates PR content: Refreshes PR title, body, and file changes
- β Maintains workflow files: Updates GitHub Actions workflows (requires proper permissions)
Workflow File Permissions
For the rebase functionality to update GitHub Actions workflow files, you need proper permissions:
Option 1: Personal Access Token (Recommended)
- Create a Personal Access Token with
repoandworkflowscopes - Add it as a repository secret named
BUDDY_BOT_TOKEN - The workflow automatically uses it when available
Option 2: Default GitHub Token (Limited)
- Uses
GITHUB_TOKENwith limited permissions - Cannot update workflow files (
.github/workflows/*.yml) - Still updates package.json, lock files, and dependency files
What Gets Updated During Rebase
- β package.json - npm/yarn/pnpm dependencies
- β Lock files - package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb
- β Dependency files - deps.yaml, dependencies.yaml, pkgx.yaml
- β GitHub Actions - workflow files (with proper permissions)
- β PR content - Updated title, body, and metadata
Quick Start
# Create basic dashboard
buddy-bot dashboard
# Create pinned dashboard with custom title
buddy-bot dashboard --pin --title "My Dependencies"Automated Dashboard Updates
Buddy Bot includes a pre-built GitHub workflow (.github/workflows/buddy-dashboard.yml) that automatically updates your dependency dashboard:
- π Scheduled: Runs Monday, Wednesday, Friday at 9 AM UTC
- π±οΈ Manual: Trigger from Actions tab with custom options
- π Auto-Pin: Keeps dashboard pinned by default
- π Dry-Run: Preview mode available
Example Dashboard Output
The dashboard automatically organizes your dependencies and shows:
## Open
The following updates have all been created. To force a retry/rebase of any, click on a checkbox below.
- [ ] <!-- rebase-branch=buddy-bot/update-react-18 -->[chore(deps): update react to v18](../pull/123) (`react`)
- [ ] <!-- rebase-branch=buddy-bot/update-types -->[chore(deps): update @types/node](../pull/124) (`@types/node`)
## Detected dependencies
<details><summary>npm</summary>
<blockquote>
<details><summary>package.json</summary>
- `react ^17.0.0`
- `typescript ^4.9.0`
- `@types/node ^18.0.0`
</details>
</blockquote>
</details>
<details><summary>github-actions</summary>
<blockquote>
<details><summary>.github/workflows/ci.yml</summary>
- `actions/checkout v3`
- `oven-sh/setup-bun v1`
</details>
</blockquote>
</details>How It Works
Buddy leverages Bun's built-in capabilities for maximum performance:
- Fast Scanning: Uses
bun outdatedto quickly identify outdated packages - Smart Parsing: Analyzes
package.json, lock files, and dependency files across your project - Dependency File Support: Automatically detects and updates pkgx and Launchpad dependency files
- Intelligent Grouping: Groups related packages to reduce PR noise
- Rich Metadata: Fetches package metadata, release notes, and changelogs
- PR Generation: Creates detailed pull requests with formatted content
Supported Dependency Files
Buddy automatically detects and updates the following dependency file formats:
Package Dependencies
- package.json - Traditional npm dependencies
- composer.json - PHP dependencies from Packagist
- composer.lock - PHP lock file with exact versions
- deps.yaml / deps.yml - Launchpad/pkgx dependency declarations
- dependencies.yaml / dependencies.yml - Alternative dependency file format
- pkgx.yaml / pkgx.yml - pkgx-specific dependency files
- .deps.yaml / .deps.yml - Hidden dependency configuration files
GitHub Actions
- .github/workflows/*.yml - GitHub Actions workflow files
- .github/workflows/*.yaml - Alternative YAML extension
All dependency files are parsed using the ts-pkgx library to ensure compatibility with the pkgx registry ecosystem while maintaining support for tools like Launchpad that reuse the same registry format. GitHub Actions are detected by parsing uses: statements in workflow files and checking for updates via the GitHub releases API.
Pull Request Format
Buddy generates comprehensive pull requests with three separate dependency tables:
1. npm Dependencies
Full table with confidence badges, age, adoption metrics, and weekly download statistics:
| Package | Change | Age | Adoption | Passing | Confidence |
|---------|--------|-----|----------|---------|------------|
| lodash | ^4.17.20 β ^4.17.21 | π
| π | β
| π |2. PHP/Composer Dependencies
Focused table for PHP packages from Packagist:
| Package | Change | File | Status |
|---------|--------|------|--------|
| laravel/framework | ^10.0.0 β ^10.16.0 | composer.json | β
Available |
| phpunit/phpunit | ^10.0.0 β ^10.3.0 | composer.json | β
Available |3. Launchpad/pkgx Dependencies
Simplified table focusing on package updates and file locations:
| Package | Change | File | Status |
|---------|--------|------|--------|
| bun.com | ^1.2.16 β ^1.2.19 | deps.yaml | β
Available |4. GitHub Actions
Workflow automation updates with direct links to repositories:
| Action | Change | File | Status |
|--------|--------|------|--------|
| actions/checkout | v4 β v4.2.2 | ci.yml | β
Available |
| oven-sh/setup-bun | v2 β v2.0.2 | release.yml | β
Available |Each table is followed by detailed release notes, changelogs, and package statistics tailored to the dependency type.
Update Strategies
all: Update all dependencies regardless of semver impactmajor: Only major version updatesminor: Major and minor updates (no patch-only)patch: All updates (major, minor, and patch)
Auto-Merge Configuration
Buddy supports configurable auto-merge for pull requests to reduce manual overhead:
const config: BuddyBotConfig = {
pullRequest: {
autoMerge: {
enabled: true,
strategy: 'squash', // 'merge', 'squash', or 'rebase'
conditions: ['patch-only'] // Optional: restrict to specific update types
}
}
}Auto-Merge Strategies
squash: Squash commits and merge (recommended for clean history)merge: Create a merge commit (preserves individual commits)rebase: Rebase and merge (linear history without merge commits)
Auto-Merge Conditions
patch-only: Only auto-merge patch version updates (safest)- No conditions: Auto-merge all updates (use with caution)
Workflow-Specific Auto-Merge
Each preset configures auto-merge appropriately:
- High Frequency Updates: Auto-merge patch updates only (6AM, 12PM, 6PM), manual review for minor updates (12AM)
- Security Focused: Auto-merge security patches every 6 hours
- Standard Project: Auto-merge daily patches, manual review for weekly/monthly updates
- Development/Testing: No auto-merge, dry-run by default, enhanced testing features.
Development & Testing
The Development/Testing preset is specifically designed for testing and development environments:
Features
- β° Every 5 minutes: Automated runs for rapid testing cycles
- π±οΈ Manual triggers: Full control via GitHub Actions UI
- π Dry run by default: Safe testing without making changes
- π Verbose logging: Detailed output for debugging
- π¦ Package-specific testing: Test updates for specific packages
- π Enhanced summaries: Detailed test reports with context
Manual Trigger Options
When running manually, you can customize:
- Update strategy: Choose patch, minor, major, or all updates
- Dry run mode: Preview changes without applying them
- Specific packages: Test updates for particular packages only
- Verbose logging: Control output detail level
Perfect For
- π§ͺ Testing new configurations
- π§ Debugging dependency issues
- π Monitoring update frequency
- π Validating workflow changes
- π Learning how Buddy Bot works
Package Grouping
Group related packages to create cleaner, more focused pull requests:
{
groups: [
{
name: 'React Ecosystem',
patterns: ['react*', '@types/react*'],
strategy: 'minor'
},
{
name: 'Development Tools',
patterns: ['eslint*', 'prettier*', '@typescript-eslint/*'],
strategy: 'patch'
}
]
}Example Output
When Buddy finds updates, it creates PRs like:
chore(deps): update all non-major dependencies
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [typescript](https://www.typescriptlang.org/) | `^5.8.2` -> `^5.8.3` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) |
---
### Release Notes
<details>
<summary>microsoft/TypeScript (typescript)</summary>
### [`v5.8.3`](https://github.com/microsoft/TypeScript/releases/tag/v5.8.3)
[Compare Source](https://github.com/microsoft/TypeScript/compare/v5.8.2...v5.8.3)
##### Bug Fixes
- Fix issue with module resolution
- Improve error messages
</details>
---
### Configuration
π
**Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
π¦ **Automerge**: Disabled by config. Please merge this manually once you are satisfied.
β» **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
π **Ignore**: Close this PR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to update/retry this PR, check this box
---
This PR was generated by [Buddy](https://github.com/stacksjs/buddy-bot).Comparison with Alternatives
| Feature | Buddy | Dependabot | Renovate |
|---|---|---|---|
| Speed | β‘ Bun-native | π Slower | π Slower |
| Package Managers | Bun, npm, yarn, pnpm, Composer, pkgx, Launchpad | Limited | Limited |
| Configuration | TypeScript, YAML, JSON/JS, package.json | YAML | JSON/JS |
| Grouping | β Flexible | β Basic | β Advanced |
| Zero Config | β Yes | β Yes | β Complex |
| Self-hosted | β Yes | β GitHub only | β Yes |
CI/CD Integration
GitHub Actions
Buddy includes powerful GitHub Actions workflow templates for different automation strategies:
# Basic dependency updates (generated by setup)
name: Buddy Update
on:
schedule:
- cron: '0 */2 * * *' # Every 2 hours
workflow_dispatch:
inputs:
strategy:
description: Update strategy
required: false
default: patch
dry_run:
description: Dry run (preview only)
required: false
default: true
type: boolean
jobs:
dependency-update:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- run: bun install
- run: bunx buddy-bot scan --strategy ${{ github.event.inputs.strategy || 'patch' }} --verbose
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- if: ${{ github.event.inputs.dry_run != 'true' }}
run: bunx buddy-bot update --strategy ${{ github.event.inputs.strategy || 'patch' }} --verbose
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}π Generate Advanced Workflows:
# Generate comprehensive GitHub Actions workflows
buddy generate-workflows
# This creates:
# - buddy-comprehensive.yml (multi-strategy scheduling)
# - dependency-updates-daily.yml (patch updates)
# - dependency-updates-weekly.yml (minor updates)
# - dependency-updates-monthly.yml (major updates)
# - buddy-monorepo.yml (monorepo support)
# - buddy-docker.yml (Docker-based)π₯ Comprehensive Multi-Strategy Workflow:
The updated workflow system automatically:
- Every 2 hours: All configured strategies with dry-run by default
- Manual trigger: Any strategy with configurable dry-run option
- Enhanced testing: Comprehensive validation and summaries
- Failure handling: Auto-creates GitHub issues
- Smart summaries: Rich GitHub Actions summaries
- Flexible scheduling: Consistent 2-hour intervals for all presets
GitHub Actions Permissions Setup
β οΈ Important: For Buddy to create pull requests in GitHub Actions workflows, you need to enable the proper permissions:
Repository Settings
- Go to your repository Settings β Actions β General
- Under "Workflow permissions", select "Read and write permissions"
- β Check "Allow GitHub Actions to create and approve pull requests"
- Click "Save"
Organization Settings (if applicable)
If your repository is part of an organization, you may also need to enable organization-level permissions:
- Go to your organization Settings β Actions β General
- Configure the same permissions as above
Quick Setup Command
# Open GitHub settings pages directly
buddy open-settings
# Or manually visit:
# Repository: https://github.com/YOUR_ORG/YOUR_REPO/settings/actions
# Organization: https://github.com/organizations/YOUR_ORG/settings/actionsTroubleshooting
If you see errors like:
GitHub Actions is not permitted to create or approve pull requestsGraphQL: GitHub Actions is not permitted to create or approve pull requests (createPullRequest)
This indicates the permissions above need to be enabled. Both GitHub CLI and REST API methods require these permissions to create PRs from workflows.
For more details, see the GitHub documentation on managing GitHub Actions settings.
Testing
bun testBuild From Source
bun run buildChangelog
Please see our releases page for more information on what has changed recently.
Contributing
Please see the Contributing Guide for details.
Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
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.
Credits
And a special thanks to Dan Scanlon for donating the stacks name on npm β¨
License
The MIT License (MIT). Please see LICENSE for more information.
Made with π