Skip to content

Commit 78ccdd0

Browse files
committed
update after review
1 parent f23f9c4 commit 78ccdd0

File tree

3 files changed

+20
-5
lines changed

3 files changed

+20
-5
lines changed
166 KB
Loading

docs/guides/modules/test/pages/fix-flaky-tests.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:experimental:
66
:page-noindex: true
77

8-
NOTE: Chunk by CircleCI is currently in *beta*. There are no extra costs during beta, Chunk uses CircleCI credits and your AI model provider token. Chunk tasks will be a paid feature when generally available.
8+
NOTE: Chunk by CircleCI is currently in *beta*. There are no extra costs during beta, Chunk uses CircleCI credits and your AI model provider tokens. Chunk tasks will be a paid feature when generally available.
99

1010
TIP: Have feedback or feature requests? Submit them on our link:https://circleci.canny.io/cloud-feature-requests?selectedCategory=chunk-ai[Ideas board, window=_blank] where you can also see existing feature requests and vote on them.
1111

@@ -150,6 +150,11 @@ Pull requests contain code diffs showing what changes Chunk recommends, along wi
150150

151151
Once you have assigned Chunk some tasks, you can view an activity timeline on the Chunk dashboard. Tasks are available in a list view below the chat interface.
152152

153+
There are two types of task, both are listed in the Chunk tasks dashboard.
154+
155+
*Manual tasks*:: Created by prompting Chunk from the chat interface. Manual tasks appear in the ist view immediately after first message to Chunk.
156+
*Schedule tasks*:: Created via the btn:[Schedule a task] button. Schedule tasks appear once the task runs on the selected schedule and if Chunk was able to open a fixPR.
157+
153158
.See Chunk tasks listed below chat interface
154159
image::guides:ROOT:chunk/chunk-chat.png[Chunk tasks listed in chat view]
155160

docs/guides/modules/toolkit/pages/chunk-setup-and-overview.adoc

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:page-description: Learn how to set up Chunk by CircleCI and see what it can do.
55
:experimental:
66

7-
NOTE: Chunk by CircleCI is currently in *beta*. There are no extra costs during beta. Chunk uses CircleCI credits and your AI model provider token. Chunk tasks will be a paid feature when generally available.
7+
NOTE: Chunk by CircleCI is currently in *beta*. There are no extra costs during beta. Chunk uses CircleCI credits and your AI model provider tokens. Chunk tasks will be a paid feature when generally available.
88

99
TIP: *Feedback or feature requests?* Submit them on our link:https://circleci.canny.io/cloud-feature-requests?selectedCategory=chunk-ai[Ideas board, window=_blank] where you can also see existing feature requests and vote on them.
1010

@@ -32,6 +32,7 @@ Ensure you have the following prerequisites in place before you get started:
3232
** Make sure your organization link:https://help.openai.com/en/articles/10910291-api-organization-verification#h_c6efff0719[has gpt-5 model access, window=_blank].
3333
** Verify your organization. For guidance see the link:https://help.openai.com/en/articles/10910291-api-organization-verification[OpenAI help, window=_blank]. If you cannot get your OpenAI organization verified, see the troubleshooting item <<i-cannot-get-my-openai-organization-verified>>.
3434
* Ensure you have the CircleCI GitHub App installed in your GitHub organization. Check menu:Organization Settings[VCS Connections]. Chunk needs the GitHub App installed to be able to recommend fixes and open pull requests.
35+
* Allow Chunk tasks for your organization: Navigate to menu:Organization Settings[Advanced] and select to toggle on the *Allow Chunk tasks* option.
3536

3637
=== Setup
3738

@@ -104,7 +105,9 @@ Chunk supports all standard CircleCI configuration options. This includes execut
104105

105106
When scheduling a task, just store your `cci-agent-setup.yml` in your repo and Chunk will pick it up automatically.
106107

107-
When using the chat interface, use the environment selection below the chat text field to set up your environment. You will also be able to add secrets (environment variables) to Chunk's environment here if needed. These secrets will be added to a context named `chunk-<your-environment-name>`.
108+
When using the chat interface, use the environment selection below the chat text field to set up your environment. If you keep the `Default` environment selected, Chunk will look for a `cci-agent-setup.yml` file in the root of your repository. If you wish to name this file differently, create a custom environment and provide chunk with the name of the file.
109+
110+
You can also add secrets (environment variables) to Chunk's environment here if needed. These secrets will be added to a context named `chunk-<your-environment-name>`.
108111

109112
.Creating an environment for Chunk to use
110113
image::guides:ROOT:chunk/chunk-create-environment.png[Create an environment for Chunk to use]
@@ -233,7 +236,7 @@ Contexts:: If you are using CircleCI contexts to manage secrets or environment v
233236

234237
=== Configuring Chunk's environment when using the chat interface
235238

236-
Using Chunk's chat interface to describe a task, you can tell Chunk which project, repository and branch you want to work on. You can also select and/or set up Chunk's environment here. Using the Environment selector you can set up your environment to give ch
239+
Using Chunk's chat interface to describe a task, you can tell Chunk which project, repository and branch you want to work on. You can also select and/or set up Chunk's environment here. Using the Environment selector you can set up your environment to give chunk access to any secrets needed or provide Chunk with the name of your agents `.yml` file if different from the default `cci-agent-setup.yml`.
237240

238241
=== Testing your environment setup
239242
To build and iterate on Chunk's environment follow these steps:
@@ -247,10 +250,17 @@ This page lets you run the contents of your cci-agent-setup.yml file on a specif
247250
Merge the `cci-agent-setup.yml` file to your default branch when the results on the environment setup page are satisfactory.
248251

249252
=== Additional guidance for Chunk
250-
To improve Chunk's ability to run tests and produce fixes that are aligned with stylistic/architectural preferences, you can include instructions. Your instructions can be in a markdown file (`claude.md` or `agents.md`) in the root of your repository or in a custom `cci-agent-setup.yml` file. Chunk should pick this up automatically.
253+
To improve Chunk's ability to run tests and produce fixes that are aligned with stylistic/architectural preferences, you can include instructions. Your instructions can be in a markdown file (`claude.md` or `agents.md`) in the root of your repository. Chunk should pick this up automatically.
251254

252255
== Troubleshooting
253256

257+
=== I cannot see the Chunk option in the sidebar
258+
259+
If you do not see Chunk image:guides:ROOT:icons/chunk.svg[Chunk icon, role="no-border"] in the sidebar, you may not have the *Allow Chunk tasks* option enabled. Navigate to menu:Organization Settings[Advanced] and select to toggle on the *Allow Chunk tasks* option.
260+
261+
.Organization settings > Advanced > Allow Chunk tasks
262+
image::guides:ROOT:chunk/allow-chunk-tasks.png[Allow Chunk tasks]
263+
254264
=== I cannot get my OpenAI organization verified
255265

256266
If organization verification is not possible, you can bypass this requirement by adding an environment variable to your `circleci-agents` context, as follows:

0 commit comments

Comments
 (0)