README.md

copilot-ops-bot

A Probot application which automates copilot-ops and allows users to generate pull-requests automatically based on issues.

---

Usage

Usage of the copilot-ops bot is simple: install this bot into your desired repository, add an issue template for the bot to process, and start making issues with that template!

Once a new issue is created with the given template, the bot will automatically attempt creating a pull request and attach it to your issue once created.

You can also customize the bot's behavior by creating a .copilot-ops.yaml file in your project's root directory.

Processing issues

In order to use this bot, simply install it in your namespace and add the bot's issue template to your .github/ISSUE_TEMPLATE directory. This bot uses the new GitHub issue template format, a sample can be found in the copilot-ops-bot repo.

You are free to create and customize your own, just be sure to have an input field with the .botInput ID. For example:

---
name: Custom Issue
description: Custom issue template example
title: "Custom Title - "
body:
	- type: input
		id: botInput
		attributes:
			label: <custom input prompt here>
	# more issue fields

Re-generating pull requests

Pull requests can be regenerated by using the /reroll command on the original issue. This will cause the bot to perform another generation of data using the original issue as input.

Customizing bot behavior

Bot behavior can be customized by including a .copilot-ops.yaml file in your project's root directory. This file can include the following customization options:

• backend: define the AI backend for file generation. Current options are gpt-3, gpt-j, opt, and bloom.
• filesets: define filesets within the config for reference in later issue labels or manually as needed.
• gpt3: define a specific config for gpt-3 generations. More information can be found here.
• gptj: define a specific config for gpt-j generations. More information can be found here.
• bloom: define a specific config for bloom generations. More information can be found here.

An example .copilot-ops.yaml configuration file:

backend: bloom
filesets:
  - name: examples
    files:
      - examples/*.yaml
  - name: stock-data
    files:
      - examples/stock-data.yaml

Contributions

See CONTRIBUTING.md on how to contribute.

---

Credit

See ACKNOWLEDGMENTS.md.