Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 3.59 KB

README.md

File metadata and controls

109 lines (71 loc) · 3.59 KB
Raw

Getting Started · Docs · Billing

FlyCI Wingman Action

Automatically Fix Your Failing CI Builds. Trust FlyCI Wingman to keep your workflows green.

Overview

FlyCI Wingman is an autonomous AI agent that analyzes failing CI builds and suggests code changes directly in your pull request. FlyCI Wingman aims to reduce the time developers spend on fixing failing CI builds, increase productivity and allow them to focus more on delivering value.

What's new

Please refer to the release page for the latest release notes.

Usage

Add fly-ci/wingman-action to your workflow job as the last step:

- uses: fly-ci/wingman-action@v1
  if: failure()

Requirements

FlyCI Application

It's required to have the FlyCI app installed for the corresponding repository for the action to work properly.

Assign required permissions

In order to get authenticated in front of the FlyCI API, the action has to obtain a short-lived access token using a GitHub OpenID Connect (OIDC) token. To do so, it is required to grant id-token: write permission to the job:

permissions:
  id-token: write
  contents: read

Example

name: CI

on:
  pull_request:

jobs:
  ci:
    runs-on: ubuntu-latest

+   permissions:
+     id-token: write
+     contents: read

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version-file: ".nvmrc"

      - name: Install dependencies
        run: npm ci

      - name: Run CI scripts
        run: npm run ci

+     - uses: fly-ci/wingman-action@v1
+       if: failure()

Supported Runners

Currently, the action is compatible with both self-hosted and GitHub-hosted runners meeting the following criteria:

Operating System Architectures Respective
GitHub-hosted runners
macOS arm64 macos-latest
macos-14
macos-latest-xlarge
macos-14-xlarge
macos-13-xlarge
ubuntu x64 ubuntu-latest
ubuntu-22.04
ubuntu-20.04
windows x64 windows-latest
windows-2022
windows-2019

Note that while it should work on other Linux platforms running on x64 architectures, we do not guarantee that.

For the complete user guide, please refer to our documentation.

Billing

Currently, FlyCI Wingman is in Beta and free of charge. For more information, please see our Billing page.

License

The scripts and documentation in this project are released under the MIT License

Feedback Channels

If you would like to report a potential issue, get help, or recommend a feature, please join our Discord Community.

Alternatively, send us an email at [email protected].