Add workflow job to deduplicate dependabot pull requests #14845
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| name: Deduplicate Dependabot | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - dependabot/npm_and_yarn/* | ||
|
|
||
| env: | ||
| NODE_VERSION: 16 | ||
| NODE_OPTIONS: --max_old_space_size=6144 | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| dedupe: | ||
| name: Deduplicate dependencies | ||
| # Only trigger on initial commit from dependabot | ||
| if: github.actor == 'dependabot[bot]' | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Generate app token | ||
| # Use a GitHub app to checkout and commit in order to re-trigger the CI workflow | ||
| # (because actions with GITHUB_TOKEN do not trigger new events) | ||
| id: generate_token | ||
| uses: tibdex/github-app-token@v1.7.0 | ||
| with: | ||
| app_id: ${{ secrets.HA_COMMITTER_APP_ID }} | ||
| private_key: ${{ secrets.HA_COMMITTER_PRIVATE_KEY }} | ||
|
Comment on lines
+32
to
+33
There was a problem hiding this comment. @balloob I'm about to transfer ownership of a simple GH app with content permissions. Could you:
|
||
| - name: Check out files from GitHub | ||
| uses: actions/checkout@v3.3.0 | ||
| with: | ||
| token: ${{ steps.generate_token.outputs.token }} | ||
| - name: Set up Node ${{ env.NODE_VERSION }} | ||
| uses: actions/setup-node@v3.6.0 | ||
| with: | ||
| node-version: ${{ env.NODE_VERSION }} | ||
| cache: yarn | ||
| - name: Install dependencies | ||
| # Do not run build scripts as a security measure since job has write permissions | ||
| run: yarn install --immutable --mode=skip-build | ||
| - name: Deduplicate dependencies | ||
| run: yarn dedupe --mode=skip-build | ||
| - name: Commit changes | ||
| run: | | ||
| git config user.name "Home Assistant Committer" | ||
| git config user.email "hello@home-assistant.io" | ||
| git add yarn.lock | ||
| git commit -m "Deduplicate dependencies [dependabot skip]" || exit 0 | ||
| git push origin "HEAD:${GITHUB_HEAD_REF}" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even with this being split out in a separate workflow, I still do not think this is something we should add.
If this is an issue, that should be documented and reported to GitHub.
We should not add this level of workarounds, that to me, at least clearly show that something is wrong with how it works.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree with @ludeeus on this.
As an alternative could be: Don't use dependabot for this task.
An alternative could be, for example, Renovate. That is a competitor to dependabot that can actually dedupe (if configured as such).
../Frenck
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renovate seems like a nice option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree Renovate is probably the better option for HA. In addition to being able to dedupe, it also handles monorepos much better, which has also been annoying from dependabot.
Closing this, but for posterity bringing it up to date and also added a simple change which addresses @ludeeus's concern about dependabot losing its rebase capability when committing the dedupe.
I'll submit a request to install Renovate and would be happy to work on the config PR.