From 9c7ab6683c290b4a28c2b85d99bc6049b791878a Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Mon, 30 Mar 2026 17:49:32 +0200 Subject: [PATCH] Add how to re-trigger a migration to the docs Also include a link to the action docs for more information. Signed-off-by: Leandro Lucarella --- docs/user-guide/update-to-a-new-version.md | 23 ++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/user-guide/update-to-a-new-version.md b/docs/user-guide/update-to-a-new-version.md index 5307fc96..57a33d61 100644 --- a/docs/user-guide/update-to-a-new-version.md +++ b/docs/user-guide/update-to-a-new-version.md @@ -11,6 +11,10 @@ command. Projects generated from the template include a GitHub Actions workflow (`repo-config-migration.yaml`) that runs the migration script automatically when [Dependabot] opens a pull request for the `repo-config` dependency group. +It is powered by the +[`gh-action-dependabot-migrate`][gh-action-dependabot-migrate] action — refer +to its documentation for full details on inputs, authentication options, trust +model, and security design. For updates where the migration script does not create additional commits and does not report manual steps, the workflow auto-approves and enables @@ -92,6 +96,24 @@ removing `tool:repo-config:migration:intervention-done` or adding `tool:repo-config:migration:intervention-pending` marks intervention as pending again. +### Re-triggering migration + +The workflow uses the `tool:repo-config:migration:executed` label to avoid +re-running migration on every trigger for the same PR. If you need to force the +migration to run again on the current PR: + +1. Remove the `tool:repo-config:migration:executed` label from the PR. +2. Trigger a Dependabot update event by commenting `@dependabot recreate` on + the PR. + +!!! Caution + + `@dependabot recreate` discards all commits on the PR branch and regenerates + it from scratch. This is usually necessary because if the migration script + already ran and committed changes, the branch will have diverged from + Dependabot's original commit, and a new Dependabot event is required for + migration to run automatically again. + !!! Note If you need to set up this workflow in a project that wasn't generated @@ -206,3 +228,4 @@ templates update commit. [Cookiecutter]: https://cookiecutter.readthedocs.io/en/stable [Dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates +[gh-action-dependabot-migrate]: https://github.com/frequenz-floss/gh-action-dependabot-migrate