Kizuna Help

Appearance

Kizuna Actions is syntax-compatible with GitHub Actions, making CI/CD migration straightforward.

Compatibility Overview ​

PlatformCompatibility
GitHub Actions✅ Native — most workflows work unchanged
GitLab CI✅ Convertible — similar concepts
Jenkins⚠️ Manual — different paradigm
CircleCI⚠️ Manual — different syntax
Travis CI⚠️ Manual — different syntax

Quick Conversion ​

GitHub Actions → Kizuna Actions ​

No changes needed for most workflows!

If you use:

  • Standard actions/* actions
  • Docker containers
  • Shell scripts
  • Common languages (Node, Python, Go, Rust)

Your workflows likely work without modification.

Common Adjustments ​

From (GitHub)To (Kizuna)
GITHUB_TOKENKIZUNA_TOKEN
github.eventkizuna.event
github.repositorykizuna.repository
actions/github-scriptkizuna/script

Migrating Secrets ​

From GitHub ​

  1. Go to Settings → Secrets → Actions
  2. Click on each secret
  3. Copy the value
  4. In Kizuna: Settings → CI/CD → Secrets
  5. Add with the same name

From GitLab ​

  1. Settings → CI/CD → Variables
  2. Export variables
  3. Import to Kizuna via API:
bash
curl -X POST https://kizuna.yourdomain.com/api/v1/repos/org/repo/secrets \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "MY_SECRET",
    "value": "secret-value",
    "protected": true
  }'

Self-Hosted Runner Migration ​

From GitHub Actions ​

GitHub runners don't migrate directly. Install Kizuna runners:

bash
# Install the runner (verifies the signed release before installing)
curl -fsSL https://kizuna.codes/install.sh | bash

# Configure
./kizuna-runner configure --url https://kizuna.yourdomain.com --token RUNNER_TOKEN

# Start
./kizuna-runner run

From GitLab Runners ​

bash
# Stop GitLab runner
sudo gitlab-runner stop

# Install Kizuna runner
curl -fsSL https://kizuna.codes/install.sh | bash
./kizuna-runner configure --url ... --token ...

Testing Migrated Pipelines ​

  1. Push a test branch
  2. Create a draft pull request
  3. Verify pipeline triggers
  4. Check all steps complete successfully
  5. Review artifacts (if applicable)

Troubleshooting ​

Action Not Found ​

yaml
# Replace GitHub-specific actions
- uses: actions/checkout@v4  # ✅ Works
- uses: github/codeql-action  # ❌ Replace with kizuna/codeql-action

Permission Denied ​

Ensure KIZUNA_TOKEN has necessary permissions in repository settings.

Runner Issues ​

bash
# Check runner status
./kizuna-runner status

# View logs
./kizuna-runner logs

Advanced Migration ​

See CI/CD Configuration for complete Kizuna Actions documentation.