add helpful comments for posterity

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: jherrflexion <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>
CDCgov · Oct 15, 2024 · a87ab5f · a87ab5f
1 parent 93b62c6
commit a87ab5f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.github/workflows/pr_agent.yml b/.github/workflows/pr_agent.yml
@@ -1,5 +1,10 @@
 name: Perry the PR Agent Platypus
 
+# Config for this action lives in .pr_agent.toml, but only the version on
+# main is read - you'll need to merge config changes before they take effect.
+# You can test config changes by making them in the `env` section below, but
+# should then move them to the config file for consistency/readability
+
 on:
   pull_request:
   issue_comment:

diff --git a/.pr_agent.toml b/.pr_agent.toml
@@ -1,4 +1,6 @@
 # See https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml for all possible config options
+# The pr_agent.yml action reads this file from the `main` branch, so changes to this file
+# will not take effect until they are merged into main
 
 [config]
 model="gpt-4" # the OpenAI model you've deployed on Azure (e.g. gpt-3.5-turbo)