Custom Bot Init

Initialize GitHub App bots with proper git configuration in seconds

Key Features

Simple, automatic bot configuration for GitHub workflows

🤖

Zero Configuration

Automatically configures git with your bot's identity using the GitHub App slug

🔐

Secure Tokens

Generates GitHub App tokens securely for API calls and git operations

⚡

Optional & Fast

Skips automatically when credentials aren't provided. No errors, no hassle

Quick Start

Add to your workflow in one step

- uses: starburst997/custom-bot-init@v1
  id: bot
  with:
    app-id: ${{ secrets.BOT_ID }}
    private-key: ${{ secrets.BOT_KEY }}

Complete Example

name: Bot Workflow

on: [push]

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

      - uses: starburst997/custom-bot-init@v1
        id: bot
        with:
          app-id: ${{ secrets.BOT_ID }}
          private-key: ${{ secrets.BOT_KEY }}

      - run: |
          # Your bot is now configured!
          echo "Bot: ${{ steps.bot.outputs.name }}"
          echo "Email: ${{ steps.bot.outputs.email }}"
          echo "User ID: ${{ steps.bot.outputs.user-id }}"

          # Make changes and commit as the bot
          npm run format
          git add -A
          git commit -m "Auto-format code"
          git push

Documentation

Inputs

Input	Description	Required
`app-id`	GitHub App ID	No
`private-key`	GitHub App private key	No

Outputs

Output	Description
`token`	Generated GitHub App token for API calls
`name`	Configured git user name (format: `app-slug[bot]`)
`email`	Configured git user email (format: `id+slug[bot]@users.noreply.github.com`)
`user-id`	Bot user ID
`slug`	GitHub App slug