Skip to content

feat(plugin-unit-tests): add a gemfile input for the Ruby specs #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanmelt merged 1 commit into from
Oct 1, 2026
Merged

feat(plugin-unit-tests): add a gemfile input for the Ruby specs #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions .github/workflows/plugin-unit-tests-reusable.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ on:
required: false
type: boolean
default: false
gemfile:
description: 'Gemfile for the Ruby specs, relative to plugin_directory (e.g. a Gemfile.dev that adds the test gems)'
required: false
type: string
default: 'Gemfile'

permissions:
contents: read
Expand Down Expand Up @@ -188,14 +193,26 @@ jobs:
working-directory: ${{ inputs.plugin_directory }}
# Caching bundler needs a lockfile to key on, and most plugins have no
# Gemfile at all, in which case the gems are installed directly below
bundler-cache: ${{ hashFiles(format('{0}/Gemfile.lock', inputs.plugin_directory)) != '' }}
bundler-cache: ${{ hashFiles(format('{0}/{1}.lock', inputs.plugin_directory, inputs.gemfile)) != '' }}
env:
# Only set for a non-default gemfile, so the default keeps setup-ruby's own lookup
BUNDLE_GEMFILE: ${{ inputs.gemfile != 'Gemfile' && format('{0}/{1}/{2}', github.workspace, inputs.plugin_directory, inputs.gemfile) || '' }}

- name: Install dependencies
working-directory: ${{ inputs.plugin_directory }}
env:
GEMFILE: ${{ inputs.gemfile }}
run: |
set -euo pipefail
if [ -f Gemfile ]; then
if [ -f "$GEMFILE" ]; then
# Exported for the spec run too, and for a Rails app's config/boot.rb
export BUNDLE_GEMFILE="$PWD/$GEMFILE"
echo "BUNDLE_GEMFILE=$BUNDLE_GEMFILE" >> "$GITHUB_ENV"
bundle install --jobs 4 --retry 3
elif [ "$GEMFILE" != "Gemfile" ]; then
# A gemfile that was asked for but is missing is a mistake, not a plugin without a Gemfile
echo "::error::gemfile '$GEMFILE' does not exist in ${{ inputs.plugin_directory }}"
exit 1
else
gem install --no-document rspec openc3
fi
Expand All @@ -206,7 +223,7 @@ jobs:
SPEC_DIR: ${{ needs.detect.outputs.ruby-dir }}
run: |
set -euo pipefail
if [ -f Gemfile ]; then
if [ -n "${BUNDLE_GEMFILE:-}" ]; then
bundle exec rspec "$SPEC_DIR" --format documentation
else
rspec "$SPEC_DIR" --format documentation
Expand Down
1 change: 1 addition & 0 deletions workflow-templates/plugin-unit-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ jobs:
# python_version: '3.12' # Uncomment and update if needed
# ruby_version: '3.4' # Uncomment and update if needed
# require_tests: true # Uncomment to fail the build when the plugin has no tests
# gemfile: Gemfile.dev # Uncomment if the specs need a different Gemfile than the plugin's own
Loading