@simple-release/github

A github addon for simple-release.

Install

# pnpm
pnpm add @simple-release/github
# yarn
yarn add @simple-release/github
# npm
npm i @simple-release/github

Usage

import { Releaser } from '@simple-release/core'
import { PnpmProject } from '@simple-release/pnpm'
import { GithubHosting } from '@simple-release/github'

await new Releaser({
  project: new PnpmProject(),
  hosting: new GithubHosting({
    token: process.env.GITHUB_TOKEN
  })
})
  .bump()
  .commit()
  .tag()
  .push()
  .publish()
  .release()
  .run()

Options

| Option | Description | |--------|-------------| | token | GitHub personal access token to authenticate with the GitHub API. | | octokit | Alternative to token, you can provide an instance of GitHub's Octokit client. | | owner | The GitHub owner (username or organization) of the repository. If not provided, it will be inferred from the remote URL. | | project | The GitHub project (repository name) to create releases in. If not provided, it will be inferred from the remote URL. |