Skip to content

DYN-9484: Add daily agentic workflow to auto-update out-of-sync documentation#17063

Open
QilongTang with Copilot wants to merge 7 commits into
masterfrom
copilot/update-repo-documentation-daily
Open

DYN-9484: Add daily agentic workflow to auto-update out-of-sync documentation#17063
QilongTang with Copilot wants to merge 7 commits into
masterfrom
copilot/update-repo-documentation-daily

Conversation

Copilot AI commented Apr 18, 2026

Copy link
Copy Markdown
Contributor

This introduces a GitHub Agentic Workflow that runs daily (weekdays) to detect documentation drift from recent code changes and open a PR with targeted doc updates when needed. It automates doc-sync maintenance while keeping write actions constrained to safe outputs.

  • Workflow definition

    • Added .github/workflows/daily-doc-sync.md with:
      • schedule: daily on weekdays + workflow_dispatch
      • read-only job permissions
      • tools.github.toolsets: [default] for repo/context access
      • safe-outputs.create-pull-request (max 1) for controlled PR creation
      • safe-outputs.create-pull-request.allowed-files to hard-enforce docs-only PR changes:
        • doc/**
        • README.md
        • CONTRIBUTING.md
    • Prompt instructions scope edits to documentation files only and skip PR creation when no doc updates are required.
  • Compiled workflow artifact

    • Added .github/workflows/daily-doc-sync.lock.yml generated from the workflow source.
  • Repo merge semantics for lock files

    • Updated .gitattributes to treat workflow lock files as generated:
      • .github/workflows/*.lock.yml linguist-generated=true
on:
  workflow_dispatch:
  schedule: daily on weekdays

permissions:
  contents: read
  issues: read
  pull-requests: read

tools:
  github:
    toolsets: [default]

safe-outputs:
  create-pull-request:
    max: 1
    allowed-files:
      - doc/**
      - README.md
      - CONTRIBUTING.md

Copilot AI and others added 2 commits April 18, 2026 14:38
Agent-Logs-Url: https://github.com/DynamoDS/Dynamo/sessions/5efe784c-4b45-4d22-9545-6dbbe05c40a7

Co-authored-by: QilongTang <3942418+QilongTang@users.noreply.github.com>
@QilongTang QilongTang marked this pull request as ready for review April 18, 2026 20:23
Copilot AI review requested due to automatic review settings April 18, 2026 20:23

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-9484

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a scheduled GitHub Agentic Workflow to detect documentation drift and (when needed) open a single PR containing targeted documentation updates, along with the compiled workflow lock artifact and merge settings for lock files.

Changes:

  • Added an agentic workflow source definition to run on weekdays and create at most one PR for doc sync updates.
  • Added the compiled workflow lock file generated from the workflow source.
  • Updated .gitattributes to mark workflow lock files as generated and to force deterministic merges.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
.github/workflows/daily-doc-sync.md Defines the agentic workflow schedule, permissions/tools, safe-outputs, and the prompt instructions for doc-only updates.
.github/workflows/daily-doc-sync.lock.yml Compiled GitHub Actions workflow that executes the agent, detection, and safe-outputs PR creation.
.gitattributes Marks lock files as generated and configures merge strategy for *.lock.yml.

Comment thread .github/workflows/daily-doc-sync.md
Comment thread .github/workflows/daily-doc-sync.md Outdated
Comment thread .github/workflows/daily-doc-sync.lock.yml Outdated
Comment thread .gitattributes Outdated
QilongTang and others added 2 commits April 18, 2026 16:31
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI and others added 2 commits April 18, 2026 20:35

Copilot AI commented Apr 18, 2026

Copy link
Copy Markdown
Contributor Author

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/actions/checkout/git/ref/tags/v6.0.2
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6.0.2 --jq .object.sha (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6.0.2 --jq .object.sha wright&#34; --viewport-size &#39;1280, 720&#39; --output-dircredential.username (http block)
  • https://api.github.com/repos/actions/download-artifact/git/ref/tags/v8.0.1
    • Triggering command: /usr/bin/gh gh api /repos/actions/download-artifact/git/ref/tags/v8.0.1 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq .object.sha (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq .object.sha wright&#34; --viewport-size &#39;1280, 720&#39; --output-dircredential.username (http block)
  • https://api.github.com/repos/actions/upload-artifact/git/ref/tags/v7.0.1
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v7.0.1 --jq .object.sha (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0.68.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.68.3 --jq .object.sha (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.68.3 --jq .object.sha wright&#34; --viewport-size &#39;1280, 720&#39; --output-dircredential.username (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI commented Apr 18, 2026

Copy link
Copy Markdown
Contributor Author

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/actions/checkout/git/ref/tags/v6.0.2
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6.0.2 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/download-artifact/git/ref/tags/v8.0.1
    • Triggering command: /usr/bin/gh gh api /repos/actions/download-artifact/git/ref/tags/v8.0.1 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq .object.sha (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq .object.sha /run/containerd/io.containerd.runtime.v2.task/moby/364c4f2d61e02145006eb38e3a51e09a5270bb1e1e8ebdc288634e1306087075/init.pid 364c4f2d61e02145006eb38e3a51e09a5270bb1e1e8ebdc288634e1306087075 (http block)
  • https://api.github.com/repos/actions/upload-artifact/git/ref/tags/v7.0.1
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v7.0.1 --jq .object.sha (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v7.0.1 --jq .object.sha /run/containerd/io.containerd.runtime.v2.task/moby/364c4f2d61e02145006eb38e3a51e09a5270bb1e1e8ebdc288634e1306087075/init.pid 364c4f2d61e02145006eb38e3a51e09a5270bb1e1e8ebdc288634e1306087075 (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0.68.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.68.3 --jq .object.sha (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants