bullet-train-co / link-local-gem

A GitHub Action to link a local copy of a gem into an application for testing

link-local-gem

A GitHub Action to link a local copy of a gem into an application for testing

In Bullet Train we use this to be able to properly test across repo boundaries when there are "join PRs" that require changes to be made in more than one repo.

Usage

- name: Link This Repo
  uses: bullet-train-co/link-local-gem@v1
  with:
    application_dir: tmp/starter
    local_gem_dir: .

Action Inputs

Name	Description	Default
application_dir	The directory where your application and Gemfile live.	N/A
local_gem_dir	The directory where the local copy of the gem lives.	N/A

Action Outputs

None

TODO: Maybe we should output some things?

Reference Example

Here is an example workflow. In this example we're checking out the bullet-train-co/bullet_train repository at tmp/starter, and then linking the gem that hosts the workflow into the starter repo.

name: CI

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  check_out_starter_repo:
    runs-on: ubuntu-latest
    name: Bullet Train Minitest

    steps:
      - name: Checkout This Repo
        uses: actions/checkout@v4

      - name: Checkout Bullet Train Starter Repo
        uses: bullet-train-co/checkout-repo-with-matching-branch@v1
        with:
          target_dir: tmp/starter
          repository: bullet-train-co/bullet_train

      - name: Link This Repo
        uses: bullet-train-co/link-local-gem@v1
        with:
          application_dir: tmp/starter
          local_gem_dir: .