Conversation
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Agentic Workflow (“daily-doc-updater”) to automatically scan recent merged PRs/commits and open documentation update PRs, along with the generated lock workflow and git attributes to treat lock files as generated.
Changes:
- Added the agent prompt/spec for the daily documentation updater workflow (
daily-doc-updater.md). - Added the compiled GitHub Actions workflow generated by
gh-aw(daily-doc-updater.lock.yml). - Marked workflow lock files as generated and set merge strategy to prefer
oursfor conflicts.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/workflows/daily-doc-updater.md | Defines the agent instructions, tool access, schedule, and safe-outputs PR creation policy. |
| .github/workflows/daily-doc-updater.lock.yml | Generated workflow that executes the agent, safe-outputs handling, and threat detection. |
| .gitattributes | Treats *.lock.yml workflow outputs as generated and resolves merge conflicts via merge=ours. |
Comments suppressed due to low confidence (2)
.github/workflows/daily-doc-updater.lock.yml:46
runs-on: ubuntu-slimis not a standard GitHub-hosted runner label (the repo’s other workflows useubuntu-latest). If this repository doesn’t provide anubuntu-slimrunner label, the workflow will never start. Consider switching toubuntu-latestor using an explicitself-hosted/custom label that’s known to exist here.
runs-on: ubuntu-slim
.github/workflows/daily-doc-updater.lock.yml:977
runs-on: ubuntu-slimis not a standard GitHub-hosted runner label (the repo’s other workflows useubuntu-latest). If this repository doesn’t provide anubuntu-slimrunner label, the workflow will never start. Consider switching toubuntu-latestor using an explicitself-hosted/custom label that’s known to exist here.
runs-on: ubuntu-slim
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| Use the GitHub tools to: | ||
| - Calculate yesterday's date: `date -u -d "1 day ago" +%Y-%m-%d` | ||
| - Search for pull requests merged in the last 24 hours using `search_pull_requests` with a query like: `repo:${{ github.repository }} is:pr is:merged merged:>=YYYY-MM-DD` (replace YYYY-MM-DD with yesterday's date) |
There was a problem hiding this comment.
The prompt uses GitHub Actions expression syntax (${{ github.repository }}) inside the agent instructions. This won’t be interpolated in the rendered prompt and may cause the agent to literally search for repo:${{ github.repository }}. Consider replacing it with a literal owner/repo placeholder (e.g., repo:OWNER/REPO) or referencing the provided workflow context value (e.g., __GH_AW_GITHUB_REPOSITORY__).
| - Search for pull requests merged in the last 24 hours using `search_pull_requests` with a query like: `repo:${{ github.repository }} is:pr is:merged merged:>=YYYY-MM-DD` (replace YYYY-MM-DD with yesterday's date) | |
| - Search for pull requests merged in the last 24 hours using `search_pull_requests` with a query like: `repo:__GH_AW_GITHUB_REPOSITORY__ is:pr is:merged merged:>=YYYY-MM-DD` (replace YYYY-MM-DD with yesterday's date) |
| id: validate-secret | ||
| run: /opt/gh-aw/actions/validate_multi_secret.sh COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default | ||
| env: | ||
| COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} |
There was a problem hiding this comment.
whose token is being used here? There are no global org tokens and this would be tied toa single user
|
@weikanglim — cool to see the GitHubNext agentic workflows template in action! A few things worth discussing before this lands: 1. 2. Doc targeting — this repo's docs aren't user-facing 3. General observations
|
To close the loop on "Learn", We would have a separate Learn generation pipeline that reads azure-dev and generates more end-user facing, friendly docs for general audience.
|
|
@weikanglim - End-user azd documentation lives on Microsoft Learn -- In general, the principle that I'd like us to adopt is to have context closest to where the code lives. I'd like to see that we have high-level product/technical docs living in azure-dev, so that all agents can iterate faster and more accurately. That is not the model we have wtith Docs for end users. We do not write the docs, the docs team does. If there are techinal docs and requirements to how we shape code or LLMS understand it, that information should live in AGENTS.md / copilot-instructions. |
spboyer
left a comment
There was a problem hiding this comment.
this is a generic template from gh next. Need to understand the benefit of creating a new docset that is out of line with the process of producing user end docs
|
@spboyer I understand the concern, but I think this is slightly different from creating a parallel end-user docset. What I’m proposing is not a replacement for the existing docs process, and not an attempt to produce user-facing documentation outside that flow.
What I’m suggesting is making space for technical and developer-focused documentation inside the azd repo. This would serve a different audience and purpose:
That kind of content serves a different purpose from polished end-user docs. It is closer to engineering context than product documentation.
In practice, I’m not convinced a single OpenAI’s approach to harness engineering is a good example of this pattern: I'm happy to spend more time to organize our docs and refining the prompt to target these content ideas more specifically, but I do believe this is a step forward in the right direction. |
Add agentic workflow daily-doc-updater