@@ -11,6 +11,10 @@ command.
1111Projects generated from the template include a GitHub Actions workflow
1212(` repo-config-migration.yaml ` ) that runs the migration script automatically
1313when [ Dependabot] opens a pull request for the ` repo-config ` dependency group.
14+ It is powered by the
15+ [ ` gh-action-dependabot-migrate ` ] [ gh-action-dependabot-migrate ] action — refer
16+ to its documentation for full details on inputs, authentication options, trust
17+ model, and security design.
1418
1519For updates where the migration script does not create additional commits and
1620does not report manual steps, the workflow auto-approves and enables
@@ -92,6 +96,24 @@ removing `tool:repo-config:migration:intervention-done` or adding
9296` tool:repo-config:migration:intervention-pending ` marks intervention as
9397pending again.
9498
99+ ### Re-triggering migration
100+
101+ The workflow uses the ` tool:repo-config:migration:executed ` label to avoid
102+ re-running migration on every trigger for the same PR. If you need to force the
103+ migration to run again on the current PR:
104+
105+ 1 . Remove the ` tool:repo-config:migration:executed ` label from the PR.
106+ 2 . Trigger a Dependabot update event by commenting ` @dependabot recreate ` on
107+ the PR.
108+
109+ !!! Caution
110+
111+ `@dependabot recreate` discards all commits on the PR branch and regenerates
112+ it from scratch. This is usually necessary because if the migration script
113+ already ran and committed changes, the branch will have diverged from
114+ Dependabot's original commit, and a new Dependabot event is required for
115+ migration to run automatically again.
116+
95117!!! Note
96118
97119 If you need to set up this workflow in a project that wasn't generated
@@ -206,3 +228,4 @@ templates update commit.
206228
207229[Cookiecutter]: https://cookiecutter.readthedocs.io/en/stable
208230[Dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates
231+ [gh-action-dependabot-migrate]: https://github.com/frequenz-floss/gh-action-dependabot-migrate
0 commit comments