plugin-github

@bonvoy/plugin-github — Default plugin

Creates GitHub releases after publishing packages. Also handles PR creation for the PR-based workflow.

Configuration

export default {
  github: {
    draft: false,        // default
    prerelease: false,   // default: auto-detected
    // owner: 'my-org',  // auto-detected from git remote
    // repo: 'my-repo',  // auto-detected from git remote
  },
};

draft

Create releases as drafts for manual review before publishing.

prerelease

Force the prerelease flag. By default, bonvoy detects prerelease versions automatically (e.g., 1.0.0-beta.1 → prerelease).

owner / repo

Usually not needed. bonvoy parses git remote get-url origin to detect the GitHub owner and repository.

Requirements

• GITHUB_TOKEN environment variable with contents: write permission
• For PR workflow: also needs pull-requests: write

permissions:
  contents: write
  pull-requests: write  # only for PR workflow
  id-token: write       # only for npm provenance

Hooks

Hook	Action
makeRelease	Creates a GitHub release for each published package
createPR	Creates a pull request (PR workflow)
rollback	Deletes GitHub releases by ID

Retry

API calls to GitHub (release creation, PR creation) are automatically retried up to 3 times with exponential backoff (1s, 2s, 4s) on transient errors (429 rate limit, 5xx server errors, network timeouts).

Release Format

For each published package, a GitHub release is created with:

• Tag: @bonvoy/core@1.2.0 (configurable via tagFormat)
• Title: @bonvoy/core v1.2.0
• Body: the package's changelog for this version
• Prerelease: auto-detected from version string