v1.0.0

First release of the Brainfish Knowledge Suggestions GitHub Action. It sends your code changes to Brainfish so it can suggest updates to your help content.

Usage

- uses: brainfish-ai/knowledge-suggestions@v1
  with:
    api_key: ${{ secrets.BRAINFISH_API_KEY }}

Full setup guide: https://help.brainfi.sh/articles/generate-knowledge-suggestions-from-github-pull-requests-fqZjjnDVOl

Features

• Run on pull requests, pushes, or any PR by number. The new pr_number input fetches the PR title, description, labels, commits, and diff from the GitHub API, so no checkout is needed. Use it to suggest on merge or from a manual workflow_dispatch.
• Lock files and generated files are never sent. Lock files, minified files, dist/, build/, node_modules/, vendor/, and binary files are dropped. Only their names are listed.
• Large diffs are summarized. Diffs over max_diff_lines (default 1000) are replaced by a summary of the changed files, line counts, and touched functions.
• Safer handling of PR content. PR titles and descriptions are passed through environment variables, not interpolated into the shell script.

Inputs

api_key (required), collection_id, pr_number, repository, github_token, base, max_diff_lines, api_url. See the README.