Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Smart Proxy plugin test in README #62

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Document Smart Proxy plugin test in README #62

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
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,32 @@ By default, this will run with the NodeJS versions that is configured in Foreman

You can alter the behavior the same way as with the Ruby tests.

## Smart Proxy plugin test

Similar to the Foreman plugin test, this is aimed at Smart Proxy plugins.
Conceptually it verifies certain Ruby versions are supported and using `test-gem.yml` to run the tests.

```
name: CI

on: pull_request

concurrency:
group: ${{ github.ref_name }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
test:
name: Tests
uses: theforeman/actions/.github/workflows/smart_proxy_plugin.yml@v0
```

It's possible to provide `foreman_proxy_version` via a parameter, but your `Gemfile` needs to respect this:

```ruby
gem 'smart_proxy', github: "theforeman/smart-proxy", branch: ENV.fetch('SMART_PROXY_BRANCH', 'develop')
```

## Gem test

To test a simple gem that only needs Ruby and bundler, use the following workflow:
Expand Down