Update tapioca definitions when updating gems

[fcheung]

Is there an existing issue for this?

• I have searched the existing issues

Feature description

I use sorbet in my rails applications, in conjunction with tapioca. Amongst other things, tapioca generates rbi files for all the gems you use, so that sorbet is aware of them. A consequence of this is that when adding/updating gems you need to run

tapioca gem

to regenerate those rbi files as required.

Could dependabot do this for me whenever updating gems? Removing manual repetitive steps in updates is exactly what I look to dependabot for.

[jeffwidman]

👋 Hey there.

Totally valid request, but I think the best way to tackle this is not via Dependabot but rather setup a GitHub action that watches for Dependabot PR's and then adds a follow-on commit running tapioca gem.

Here's an example action to help you get started hacking: https://github.com/dependabot/fetch-metadata/

Although ☝️ is probably more complicated than what you're looking for, it should be easy to strip it down to only what you need.

[fcheung]

Thanks - that works well enough. If anyone else runs into this, this workflow seems to work well enough for us:

name: Dependabot Tapioca updates
on:
  pull_request:
    types: [opened, synchronize]

permissions:
  contents: write
  pull-requests: read
jobs:
  build:
    if: ${{ github.actor == 'dependabot[bot]' }}
    runs-on: ubuntu-latest
    steps:
      - name: Fetch Dependabot metadata
        id: dependabot-metadata
        uses: dependabot/fetch-metadata@v1
      - uses: actions/checkout@v3
        if: ${{ steps.dependabot-metadata.outputs.package-ecosystem == 'bundler' }}
        with:
          ref: ${{ github.event.pull_request.head.sha }}

      - uses: ruby/setup-ruby@v1
        if: ${{ steps.dependabot-metadata.outputs.package-ecosystem == 'bundler' }}
        with:
          ruby-version: '3.1.2'
          bundler-cache: true 
      - name: Tapioca update
        if: ${{ steps.dependabot-metadata.outputs.package-ecosystem == 'bundler' }}
        run: bin/tapioca gem
      - name: git update
        if: ${{ steps.dependabot-metadata.outputs.package-ecosystem == 'bundler' }}
        run: |
          git config --global user.name 'some user'
          git config --global user.email '[email protected]'
          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
          git add sorbet/rbi/gems
          git commit -m "updated tapioca definitions" sorbet/rbi/gems
          git push -u origin HEAD:${{ github.event.pull_request.head.ref }}

[jeffwidman]

Glad to hear it. Thanks for circling back to share your solution with others.

[eric-hu]

@fcheung thank you for sharing your solution. By any chance, did you have to do any extra configuration of your Github Actions? The commit back to the branch works, but Github Actions doesn't trigger off the pushed commit for me.

[jeffwidman]

Are you using a PAT?

Because otherwise you can't trigger a GitHub action from a GitHub action:
https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow

[eric-hu]

Ahh thank you for the link @jeffwidman! This matches my problem.