Skip to content

Conversation

@kazo0
Copy link
Contributor

@kazo0 kazo0 commented Dec 8, 2025

This pull request introduces a new automated workflow for keeping external documentation commit hashes up to date. It adds a reusable GitHub Action and a scheduled workflow that regularly checks for the latest commits in a list of external repositories, updates the tracked commit hashes in doc/import_external_docs.ps1, and creates a pull request with the changes. This ensures that the documentation always references the most current versions of external docs.

Automation of external docs tracking:

  • Added a new composite GitHub Action (.github/actions/docs-update/action.yml) that fetches the latest commit hashes from the default branches of a predefined list of external repositories, updates the corresponding entries in doc/import_external_docs.ps1, and displays a diff for verification.

Scheduled workflow integration:

  • Introduced a new workflow (.github/workflows/docs-updater.yml) that runs the docs update action every 6 hours and on manual dispatch, checks out the relevant branch, updates hashes, and automatically creates a pull request with the changes. Automerge is enabled for these pull requests.
  • The workflow dynamically detects each repository's default branch (e.g., main or master) to ensure hashes are always up to date with the latest commits. [1] [2]

Copilot AI review requested due to automatic review settings December 8, 2025 21:23
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces an automated workflow to keep external documentation commit hashes synchronized with their source repositories. The implementation adds a scheduled GitHub Actions workflow that runs every 6 hours to fetch the latest commit hashes from external documentation repositories and creates pull requests with the updates.

Key changes:

  • New composite action that dynamically fetches latest commits from external repo default branches using GitHub API
  • Scheduled workflow with automatic PR creation and automerge enabled
  • Updates target the doc/import_external_docs.ps1 file to maintain current documentation references

Reviewed changes

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

File Description
.github/workflows/docs-updater.yml Defines scheduled workflow (every 6 hours) that runs the docs-update action, creates PRs with updated hashes, and enables automerge
.github/actions/docs-update/action.yml Composite action that fetches latest commit hashes from 13 external repos via GitHub API, updates the import script using regex replacement, and shows git diff

Copy link
Contributor

Copilot AI commented Dec 8, 2025

@kazo0 I've opened a new pull request, #22049, to work on those changes. Once the pull request is ready, I'll request review from you.

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-22048/docs/index.html

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-22048/docs/index.html

Copilot AI review requested due to automatic review settings December 9, 2025 17:23
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

Copy link
Contributor

Copilot AI commented Dec 9, 2025

@kazo0 I've opened a new pull request, #22066, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI review requested due to automatic review settings December 9, 2025 17:47
Copy link
Contributor

Copilot AI commented Dec 9, 2025

@kazo0 I've opened a new pull request, #22067, to work on those changes. Once the pull request is ready, I'll request review from you.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

Comments suppressed due to low confidence (1)

.github/workflows/docs-updater.yml:87

  • Missing merge method specification for automerge

The automerge action is enabled without specifying the merge method. By default, this may use "merge commit" which could be inconsistent with repository preferences.

Consider explicitly specifying the merge method:

- name: Enable Pull Request Automerge
  if: steps.cpr.outputs.pull-request-operation == 'created'
  uses: peter-evans/enable-pull-request-automerge@a660677d5469627102a1c1e11409dd063606628d # v3.0.0
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
    merge-method: squash  # or 'merge' or 'rebase'

This makes the merge strategy explicit and prevents unexpected behavior if repository default settings change.

          token: ${{ secrets.GITHUB_TOKEN }}
          pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-22048/docs/index.html

Copilot AI review requested due to automatic review settings December 9, 2025 19:05
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-22048/docs/index.html

Copilot AI review requested due to automatic review settings December 9, 2025 20:24
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-22048/docs/index.html

@kazo0 kazo0 enabled auto-merge December 9, 2025 20:48
@unoplatform unoplatform deleted a comment from CLAassistant Dec 9, 2025
@kazo0 kazo0 disabled auto-merge December 9, 2025 20:51
@jeromelaban jeromelaban merged commit ed3387c into master Dec 9, 2025
13 checks passed
@jeromelaban jeromelaban deleted the dev/sb/docs-auto-pr branch December 9, 2025 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants