github-action

@simple-release/github-action

A simple-release api for github action.

Install

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

Usage

import { getOctokit } from '@actions/github'
import { load } from '@simple-release/config'
import { ReleaserGithubAction } from '@simple-release/github-action'

const {
  project,
  releaser,
  ...options
} = await load({
  config: true,
  project: true
})

// Detect the current event context and run the pull request or release flow
await new ReleaserGithubAction({
  project,
  octokit: getOctokit(process.env.GITHUB_TOKEN),
  ...releaser
})
  .setOptions(options)
  .runAction()

Documentation

For comprehensive guides and API reference, visit the documentation website.