Skip to content

Commit d6e8049

Browse files
committed
add concepts
1 parent c61b15b commit d6e8049

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

docs/concepts.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 📖 Introduction to Agentic Workflows
22

3-
Now that you've got your first workflow running, let's dive deeper into the concepts and capabilities of GitHub Agentic Workflows.
3+
Now that you've [got your first workflow running](quick-start.md), let's dive deeper into the concepts and capabilities of GitHub Agentic Workflows.
44

55
GitHub Agentic Workflows represent a new paradigm where AI agents can perform complex, multi-step tasks in conjunction with your team automatically. They combine the power of AI with GitHub's collaboration platform to enable [Continuous AI](https://githubnext.com/projects/continuous-ai) — the systematic, automated application of AI to software collaboration.
66

@@ -31,20 +31,23 @@ Every agentic workflow has two main parts:
3131
on: ...
3232
permissions: ...
3333
tools: ...
34+
steps: ...
3435
---
3536

3637
# Natural Language Instructions
3738
Analyze this issue and provide helpful triage comments...
3839
```
3940

40-
See [Workflow Structure](workflow-structure.md) for details on file layout and security.
41+
One crucial difference from traditional agentic prompting is that GitHub Agentic Workflows can contain **both** traditional GitHub Actions steps and agentic natural language instructions. This allows the best of both worlds: traditional steps for deterministic actions, and agentic steps for flexible, context-aware AI-driven actions.
42+
43+
See [Workflow Structure](workflow-structure.md) and [Frontmatter Options](frontmatter.md) for details of file layout and configuration options.
4144

4245
## Understanding AI Engines
4346

44-
Agentic workflows are powered by different AI engines:
47+
Agentic workflows are powered by different agentic AI engines:
4548

46-
- **Claude** (default) — Anthropic's AI model, excellent for reasoning and code analysis
47-
- **Codex** (experimental) — OpenAI's code-focused model
49+
- **Claude Code** (default) — Anthropic's AI engine, excellent for reasoning and code analysis
50+
- **Codex** (experimental) — OpenAI's code-focused engine
4851

4952
The engine interprets your natural language instructions and executes them using the tools and permissions you've configured.
5053

@@ -58,13 +61,13 @@ GitHub Agentic Workflows enable [Continuous AI](https://githubnext.com/projects/
5861
- **Continuous Research** — Stay current with industry developments
5962
- **Continuous Quality** — Automated code review and standards enforcement
6063

61-
#### Demonstrator Research & Planning Workflows
64+
**Demonstrator Research & Planning Workflows**
6265
- [📚 Weekly Research](https://github.com/githubnext/agentics?tab=readme-ov-file#-weekly-research) - Collect research updates and industry trends
6366
- [👥 Daily Team Status](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-team-status) - Assess repository activity and create status reports
6467
- [📋 Daily Plan](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-plan) - Update planning issues for team coordination
6568
- [🏷️ Issue Triage](https://github.com/githubnext/agentics?tab=readme-ov-file#️-issue-triage) - Triage issues and pull requests
6669

67-
#### Demonstrator Coding & Development Workflows
70+
**Demonstrator Coding & Development Workflows**
6871
- [📦 Daily Dependency Updater](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-dependency-updater) - Update dependencies and create pull requests
6972
- [📖 Regular Documentation Update](https://github.com/githubnext/agentics?tab=readme-ov-file#-regular-documentation-update) - Update documentation automatically
7073
- [🔍 Daily QA](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-qa) - Perform quality assurance tasks
@@ -84,6 +87,8 @@ gh aw compile
8487

8588
This generates a `.lock.yml` file containing the actual GitHub Actions workflow. Both files should be committed to your repository.
8689

90+
The `.lock.yml` file contains the full configuration of the workflow, including the frontmatter and the compiled agentic steps, added security hardening and job orchestration. The `.md` file is the source of truth for authoring and editing.
91+
8792
### Security and Permissions
8893

8994
Agentic workflows require careful security consideration:
@@ -115,6 +120,7 @@ Learn more in [Tools Configuration](tools.md) and [MCPs](mcps.md).
115120
3. **Test iteratively** — Use `gh aw compile --watch` and `gh aw run` during development
116121
4. **Monitor costs** — Use `gh aw logs` to track AI usage and optimize
117122
5. **Review outputs** — Always verify AI-generated content before merging
123+
6. **Use safe outputs** — Leverage [Safe Output Processing](safe-outputs.md) to automatically create issues, comments, and PRs from agent output
118124

119125
### Common Patterns
120126

0 commit comments

Comments
 (0)