Skip to content

Add docs-update agentic workflow - #4465

Open
antgamdia wants to merge 4 commits into
mainfrom
TRNT-4543-auto-docs
Open

Add docs-update agentic workflow#4465
antgamdia wants to merge 4 commits into
mainfrom
TRNT-4543-auto-docs

Conversation

@antgamdia

Copy link
Copy Markdown
Contributor

Description

This PR brings the first "agentic workflow" to this repository. The idea is to have something running daily and updating the documentation based on the recent additions in the repository.

Related #SAPSOL-4543

How was this tested?

I created this in my fork first.

Documentation changes

No

Additional information

This is an example of what we would get: antgamdia#3

Read more at https://github.github.com/gh-aw/

Prerequisites:

  1. This option has to be enabled in the repo settings:
image
  1. We need a COPILOT_GITHUB_TOKEN. For now, the "agentic time" would be billed to an individual (unless the repo belongs to an organization with Copilot enabled already)

Signed-off-by: Antonio Gamez Diaz <antonio.gamez@suse.com>
@antgamdia
antgamdia requested a review from nelsonkopliku July 6, 2026 11:17

@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.

license-eye has checked 2392 files.

Valid Invalid Ignored Fixed
1867 4 521 0
Click to see the invalid file list
  • .gitattributes
  • .github/workflows/agentics-maintenance.yml
  • .github/workflows/copilot-setup-steps.yml
  • .github/workflows/daily-doc-updater.lock.yml
Use this command to fix any missing license headers
```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

Comment thread .github/workflows/agentics-maintenance.yml
Comment thread .github/workflows/copilot-setup-steps.yml
Comment thread .github/workflows/daily-doc-updater.lock.yml Outdated
antgamdia added 2 commits July 6, 2026 17:22
Signed-off-by: Antonio Gamez Diaz <antonio.gamez@suse.com>
Signed-off-by: Antonio Gamez Diaz <antonio.gamez@suse.com>
name: Documentation Updater
description: Automatically reviews and updates documentation based on recent code changes
on:
schedule: weekly

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I made it weekly, as we discussed offline, @eromanova97

@antgamdia
antgamdia requested a review from vicenteqa July 29, 2026 08:03

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 the repository’s first gh-aw “agentic workflow” to periodically open documentation update PRs, along with the generated lock/maintenance artifacts and supporting repo configuration.

Changes:

  • Introduces a documentation-updater agentic workflow source (.md) plus its compiled workflow lock file (.lock.yml)
  • Adds gh-aw maintenance workflow + repo scaffolding (actions lock, agent/skill router docs)
  • Tweaks repo config to treat lock files as generated and exclude them from license header checks

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
.licenserc.yaml Excludes gh-aw generated/lock workflow files from license header enforcement.
.github/workflows/weekly-doc-updater.md Source definition + prompt for the doc-updater agentic workflow.
.github/workflows/weekly-doc-updater.lock.yml Compiled gh-aw lock workflow that runs in Actions.
.github/workflows/copilot-setup-steps.yml Adds Copilot Agent setup workflow for installing gh-aw tooling.
.github/workflows/agentics-maintenance.yml Adds generated gh-aw maintenance workflow for expiring safe outputs and ops tasks.
.github/skills/agentic-workflows/SKILL.md Adds a routing skill for gh-aw workflow-related requests.
.github/aw/actions-lock.json Pins gh-aw helper actions to SHAs/versions.
.github/agents/agentic-workflows.md Adds an agent definition describing how to route gh-aw tasks.
.gitattributes Marks *.lock.yml as generated and resolves merges via ours.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +23 to +26
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Install gh-aw extension
Comment on lines +4 to +6
on:
schedule: weekly
workflow_dispatch:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants