GitHub Actions Integration

Generate pull request and release artifacts in CI/CD workflows.

Overview

Smoothdev provides GitHub Actions for automated documentation generation in CI/CD pipelines.

When to Use It

Automate PR summary generation on pull request events
Generate release notes on tag push
Integrate documentation generation into existing workflows

How It Works

Add Smoothdev API key as repository secret
Create workflow file in .github/workflows/
Action runs on specified events (PR open, tag push)
Generated content is output or pushed to GitHub

Configuration

Repository Secret

Go to repository Settings → Secrets and variables → Actions
Add secret named SMOOTHDEV_API_KEY with your API key

Available Actions

Action	Description
smoothdev-io/pr-summary-action	Generate PR titles and summaries
smoothdev-io/release-notes-action	Generate release notes on tag push

Output Behavior

PR Summary Action

- uses: smoothdev-io/pr-summary-action@v1
  with:
    api_key: ${{ secrets.SMOOTHDEV_API_KEY }}
    push_to_pr: true

Input	Description	Required	Default
`api_key`	Smoothdev API key	Yes	-
`push_to_pr`	Update PR with content	No	`false`

Release Notes Action

- uses: smoothdev-io/release-notes-action@v1
  with:
    api_key: ${{ secrets.SMOOTHDEV_API_KEY }}
    push_to_github: true
    release_tag: ${{ github.ref_name }}

Input	Description	Required	Default
`api_key`	Smoothdev API key	Yes	-
`release_tag`	Tag for the release	Yes	-
`push_to_github`	Create GitHub Release	No	`false`

Security and Data Handling

Smoothdev encrypts customer data in transit and at rest using tenant-scoped encryption keys. Source data is processed only for the requested operation and is not retained long term. Generated artifacts are returned to the user. Operational metrics and validation logs are retained to improve system reliability and quality.

Limitations

Actions require SMOOTHDEV_API_KEY stored as repository or organization secret
PR Summary Action requires pull-requests: write permission
Release Notes Action requires contents: write permission
Self-hosted runners require network access to Smoothdev API
Rate limits: 100 requests per minute per API key

Troubleshooting

Error	Cause	Resolution
`Authentication failed`	Invalid API key	Verify `SMOOTHDEV_API_KEY` secret value
`Permission denied`	Missing workflow permissions	Add required permissions block
`Rate limit exceeded`	Too many requests	Wait for rate limit reset