GH Agentic Workflows Proof of Concept

Pre-requisites

• To follow this repository, complete the steps up to Step 1 in the provided link:
  Quick Start - Prerequisites
• Ensure that you add your AI API Key to the GitHub Action secrets:
  Authenticating Your Coding Agent AI Engine

Adding a Custom Workflow

• Create a new file at .github/workflows/<workflow-name>.md.

• The workflow markdown file consists of two major parts:

  • Frontmatter: The frontmatter has three components:

    • triggers: Defines when the workflow runs.
    • permissions: Specifies what the workflow can access.
    • tools: Outlines the capabilities of the AI.

    ---
    on: ...
    permissions: ...
    tools: ...

  • Markdown Instructions: This section includes natural language task descriptions.

    ---
    # Natural Language Instructions
    Analyze this issue and provide helpful triage comments...

• Below is the sample workflow file Frontmatter + markdown instructions

  ---
  on: ...
  permissions: ...
  tools: ...
  ---
  # Natural Language Instructions
  Analyze this issue and provide helpful triage comments...

• Use the command gh aw compile to produce a .github/workflows/<workflow-name>.lock.yml file.

• Commit and push your changes.

Prompting for a workflow markdown file

We can feed a chatbot instructions on how to author our agentic workflow
https://github.github.com/gh-aw/guides/agentic-authoring/#planner

Not Starting from Scratch

• There is a repository that contains pre-made markdown files.
• You can copy one of the markdown files from this repository:
  Awesome Agentic Workflows - Security Templates

Special Mention

This template was generated with the assistance of Duck.ai, showcasing the capabilities of AI in streamlining workflow processes. Also, shoutout to OneRose328 for the awesome-agentic-workflow repo!

References

• Workflow Structure
• Quick Start Guide
• Prerequisites Documentation
• Security Templates Repository