Skip to content

Commit f5dca2d

Browse files
committed
BAU: Add more instructions for dependabot tf PRs
GitHub protects us from recursion by not running workflows on commits made by GitHub bots. This could be solved later by using a custom bot user with a PAT, but for now we can just add instructions to the PR body to tell maintainers to amend the PR to get the checks to run. Also, things can get a bit messy if dependabot tries to update dependencies on a PR where the lockfiles have already been updated. So add a warning to tell maintainers to recreate the PR if that happens.
1 parent a5b8581 commit f5dca2d

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

.github/workflows/update-provider-locks.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,19 @@ jobs:
146146
>
147147
> The changes are ready for review and merge.
148148
149+
> [!IMPORTANT]
150+
> The actions have not been run on this PR since the lock files were updated, because GHA won't run \`push\` actions when the commit has been made by a bot.
151+
> To get the CI checks to run, you will need to amend the PR:
152+
> 1. Check out the PR branch locally: \`git checkout ${{github.base_ref}}\`
153+
> 2. Pull the latest changes: \`git pull\`
154+
> 3. Make a no-op amendment: \`git commit --amend --no-edit\`
155+
> 4. Push the amended commit: \`git push --force-with-lease\`
156+
>
157+
> This will trigger the CI checks to run with the updated lock files.
158+
159+
> [!WARNING]
160+
> If dependabot has attempted to modify the PR (ie. if there are new dependency updates available), comment \`@dependabot recreate\` and it'll recreate the PR from scratch (allowing the lock files to be updated correctly).
161+
149162
${COMMENT_MARKER}
150163
EOF
151164

0 commit comments

Comments
 (0)