Add token configuration and workflow creation documentation for agentic workflows #4

Copilot · 2025-12-20T18:54:27Z

The README lacked instructions for configuring repository secrets needed to run agentic workflows with Copilot and other engines, as well as guidance on creating and debugging workflows.

Changes

Quick reference table: Maps workflow capabilities (Copilot, cross-repo, Projects v2) to required secrets
Setup guide: PAT creation → secret configuration via GitHub website UI (3 step process)
Workflow creation guide: Instructions for using the create-agentic-workflow custom agent to generate new workflows
Workflow debugging guide: Instructions for using the debug-agentic-workflow custom agent to analyze and fix workflow issues

Creating Workflows

Users can now create workflows through the GitHub web UI:

Go to repository Actions tab
Click Create new agentic task
Select create-agentic-workflow agent
Describe the desired workflow
Agent generates the workflow file

Debugging Workflows

Users can debug failed workflows:

Go to repository Actions tab
Click Create new agentic task
Select debug-agentic-workflow agent
Provide GitHub URL to failed workflow run
Agent analyzes logs and suggests fixes

All instructions use the GitHub website interface exclusively, making it accessible to users who only use GitHub.com. The README is streamlined and concise, focusing on getting started quickly without detailed technical reference material.

Original prompt

Update the README file with instructions on how to configure this repository for agentic workflows. Focus on a clear list of steps to configure tokens for copilot.

see https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/tokens.md

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pelikhan <[email protected]>

pelikhan · 2025-12-20T19:05:03Z

README.md

+
+Follow these steps to set up GitHub Copilot in your agentic workflows:
+
+#### 1. Install the GitHub Agentic Workflows CLI


@copilot this step is preconfigured, remove

Removed CLI installation step in commit 5a3291c

pelikhan · 2025-12-20T19:05:20Z

README.md

+./install-gh-aw.sh
+```
+
+#### 2. Create a Personal Access Token for Copilot


@copilot this step is mandatory, move up as the first thing to do

Moved PAT creation to be step 1 in commit 5a3291c

pelikhan · 2025-12-20T19:05:46Z

README.md

+   - **Permissions**: Select "Copilot Requests" (required)
+3. Generate the token and copy it
+
+#### 3. Set the Copilot Token as a Repository Secret


@copilot give instructions using the github web site, not the gh cli

Updated to use GitHub website instructions for setting secrets in commit 5a3291c

pelikhan · 2025-12-20T19:06:06Z

README.md

+echo "YOUR_COPILOT_PAT" | gh aw secrets set COPILOT_GITHUB_TOKEN
+```
+
+#### 4. (Optional) Configure Additional Tokens


@copilot do not give instructions using gh cli the audience uses dotcom only

Replaced gh CLI instructions with GitHub website steps in commit 5a3291c

pelikhan · 2025-12-20T19:06:18Z

README.md

+- For Organization-owned Projects (option 1): Classic PAT with `project` + `read:org` scopes
+- For Organization-owned Projects (option 2): Fine-grained PAT with explicit Organization access + Projects: Read+Write
+
+### Security Best Practices


@copilot remove section

Removed Security Best Practices section in commit 5a3291c

…e CLI installation and security section Co-authored-by: pelikhan <[email protected]>

pelikhan · 2025-12-20T19:19:05Z

README.md

+- For Organization-owned Projects (option 1): Classic PAT with `project` + `read:org` scopes
+- For Organization-owned Projects (option 2): Fine-grained PAT with explicit Organization access + Projects: Read+Write
+
+### Example Workflow Using Copilot


@copilot remove section

Removed "Example Workflow Using Copilot" section in commit 1f45b88

pelikhan · 2025-12-20T19:19:23Z

README.md

+
+This will generate `.github/workflows/copilot-helper.lock.yml`, which is the actual GitHub Actions workflow file that will run.
+
+## Next Steps


@copilot remove this section

Removed "Next Steps" section in commit 1f45b88

pelikhan · 2025-12-20T19:20:17Z

README.md

+```
+
+This will generate `.github/workflows/copilot-helper.lock.yml`, which is the actual GitHub Actions workflow file that will run.
+


@copilot add a section that tells the user how to use the "create new agentic task", select the "create-agentic-workflow" custom agent and ask to create a new workflow. Also add section on how to use the debug-agentic-workflow + github url to improve debug agents.

Added "Creating Workflows" section with create-agentic-workflow agent instructions and "Debugging and Improving Workflows" section with debug-agentic-workflow + GitHub URL instructions in commit 1f45b88

…n and debugging sections Co-authored-by: pelikhan <[email protected]>

pelikhan · 2025-12-20T19:27:28Z

README.md

+- **For agent assignment operations**: Create a secret named `GH_AW_AGENT_TOKEN`
+- **For GitHub Projects v2 operations**: Create a secret named `GH_AW_PROJECT_GITHUB_TOKEN`
+
+### Token Types and Permissions


@copilot remove section

Removed "Token Types and Permissions" section in commit 344a114

Co-authored-by: pelikhan <[email protected]>

Initial plan

e85c5cf

Copilot AI assigned Copilot and pelikhan Dec 20, 2025

Copilot started work on behalf of pelikhan December 20, 2025 18:54 View session

Copilot AI and others added 3 commits December 20, 2025 18:58

Add comprehensive token configuration instructions to README

cf1f5a5

Co-authored-by: pelikhan <[email protected]>

Clarify workflow file format and add note about activation context

82c5204

Co-authored-by: pelikhan <[email protected]>

Address code review nitpicks for improved clarity

3a2f246

Co-authored-by: pelikhan <[email protected]>

Copilot AI changed the title ~~[WIP] Update README with agentic workflows configuration instructions~~ Add token configuration documentation for agentic workflows Dec 20, 2025

Copilot AI requested a review from pelikhan December 20, 2025 19:03

Copilot finished work on behalf of pelikhan December 20, 2025 19:03

pelikhan reviewed Dec 20, 2025

View reviewed changes

Copilot started work on behalf of pelikhan December 20, 2025 19:06 View session

Address feedback: use GitHub web UI for secrets, reorder steps, remov…

5a3291c

…e CLI installation and security section Co-authored-by: pelikhan <[email protected]>

Copilot finished work on behalf of pelikhan December 20, 2025 19:11

Copilot AI requested a review from pelikhan December 20, 2025 19:11

pelikhan reviewed Dec 20, 2025

View reviewed changes

Copilot started work on behalf of pelikhan December 20, 2025 19:20 View session

Remove example workflow and next steps sections, add workflow creatio…

1f45b88

…n and debugging sections Co-authored-by: pelikhan <[email protected]>

Copilot AI changed the title ~~Add token configuration documentation for agentic workflows~~ Add token configuration and workflow creation documentation for agentic workflows Dec 20, 2025

Copilot AI requested a review from pelikhan December 20, 2025 19:24

Copilot finished work on behalf of pelikhan December 20, 2025 19:24

pelikhan reviewed Dec 20, 2025

View reviewed changes

Copilot started work on behalf of pelikhan December 20, 2025 19:27 View session

Remove Token Types and Permissions section

344a114

Co-authored-by: pelikhan <[email protected]>

Copilot AI requested a review from pelikhan December 20, 2025 19:30

Copilot finished work on behalf of pelikhan December 20, 2025 19:30

pelikhan marked this pull request as ready for review December 20, 2025 19:36

pelikhan merged commit 2466cc2 into main Dec 20, 2025

pelikhan deleted the copilot/update-readme-configure-agentic-workflows branch December 20, 2025 19:37


		Follow these steps to set up GitHub Copilot in your agentic workflows:

		#### 1. Install the GitHub Agentic Workflows CLI


		This will generate `.github/workflows/copilot-helper.lock.yml`, which is the actual GitHub Actions workflow file that will run.

		## Next Steps

Add token configuration and workflow creation documentation for agentic workflows #4

Add token configuration and workflow creation documentation for agentic workflows #4

Uh oh!

Conversation

Copilot AI commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Creating Workflows

Debugging Workflows

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Dec 20, 2025 •

edited

Loading